Função DsGetDomainControllerInfoA (ntdsapi.h)

Artigo
11/20/2024

A função DsGetDomainControllerInfo recupera dados sobre os controladores de domínio em um domínio.

Sintaxe

NTDSAPI DWORD DsGetDomainControllerInfoA(
  [in]  HANDLE hDs,
  [in]  LPCSTR DomainName,
  [in]  DWORD  InfoLevel,
  [out] DWORD  *pcOut,
  [out] VOID   **ppInfo
);

Parâmetros

[in] hDs

Contém um identificador de serviço de diretório obtido da função DSBind ou DSBindWithCred.

[in] DomainName

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica o nome de domínio.

[in] InfoLevel

Contém um valor que indica a versão da estrutura de DS_DOMAIN_CONTROLLER_INFO a ser retornada. Esse pode ser um dos valores a seguir.

1

A função fornece os dados de domínio no formato de estrutura DS_DOMAIN_CONTROLLER_INFO_1.

2

A função fornece os dados de domínio no formato de estrutura DS_DOMAIN_CONTROLLER_INFO_2.

3

A função fornece os dados de domínio no formato de estrutura DS_DOMAIN_CONTROLLER_INFO_3.

[out] pcOut

Ponteiro para uma variável DWORD que recebe o número de itens retornados em matriz de ppInfo.

[out] ppInfo

Ponteiro para uma variável de ponteiro que recebe uma matriz de estruturas DS_DOMAIN_CONTROLLER_INFO_*. O tipo de estruturas nessa matriz é definido pelo parâmetro InfoLevel. O chamador deve liberar essa matriz, quando ela não for mais necessária, usando a função DsFreeDomainControllerInfo .

Valor de retorno

Se a função retornar dados do controlador de domínio, o valor retornado será ERROR_SUCCESS. Se o chamador não tiver os privilégios para acessar os objetos do servidor, o valor retornado será ERROR_SUCCESS, mas as estruturas de DS_DOMAIN_CONTROLLER_INFO poderão estar vazias.

Se a função falhar, o valor retornado poderá ser um dos seguintes códigos de erro.

Observações

Nota

O cabeçalho ntdsapi.h define DsGetDomainControllerInfo como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows Vista
servidor com suporte mínimo	Windows Server 2008
da Plataforma de Destino	Windows
cabeçalho	ntdsapi.h
biblioteca	Ntdsapi.lib
de DLL	Ntdsapi.dll

Consulte também

DS_DOMAIN_CONTROLLER_INFO_1

DS_DOMAIN_CONTROLLER_INFO_2

DS_DOMAIN_CONTROLLER_INFO_3

Funções de gerenciamento de replicação e controlador de domínio

DsBind

DsBindWithCred

DsFreeDomainControllerInfo

Compartilhar via