Функция DsGetDomainControllerInfoA (ntdsapi.h)

Статья
11/20/2024

Функция DsGetDomainControllerInfo извлекает данные о контроллерах домена в домене.

Синтаксис

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

Параметры

[in] hDs

Содержит дескриптор службы каталогов, полученный из функции DSBind или DSBindWithCred.

[in] DomainName

Указатель на строку, завершающую значение NULL, которая указывает доменное имя.

[in] InfoLevel

Содержит значение, указывающее версию возвращаемой структуры DS_DOMAIN_CONTROLLER_INFO. Это может быть одно из следующих значений.

1

Функция предоставляет данные домена в формате структуры DS_DOMAIN_CONTROLLER_INFO_1.

2

Функция предоставляет данные домена в формате структуры DS_DOMAIN_CONTROLLER_INFO_2.

3

Функция предоставляет данные домена в формате структуры DS_DOMAIN_CONTROLLER_INFO_3.

[out] pcOut

Указатель на переменную DWORD , которая получает количество элементов, возвращаемых в массиве ppInfo.

[out] ppInfo

Указатель на переменную указателя, которая получает массив структур DS_DOMAIN_CONTROLLER_INFO_*. Тип структур в этом массиве определяется параметром InfoLevel. Вызывающий объект должен освободить этот массив, если он больше не требуется, используя функцию DsFreeDomainControllerInfo.

Возвращаемое значение

Если функция возвращает данные контроллера домена, возвращаемое значение ERROR_SUCCESS. Если вызывающий объект не имеет прав доступа к объектам сервера, возвращаемое значение ERROR_SUCCESS, но DS_DOMAIN_CONTROLLER_INFO структуры могут быть пустыми.

Если функция завершается ошибкой, возвращаемое значение может быть одним из следующих кодов ошибок.

Замечания

Заметка

Заголовок ntdsapi.h определяет DsGetDomainControllerInfo как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows Vista
минимальный поддерживаемый сервер	Windows Server 2008
целевая платформа	Виндоус
заголовка	ntdsapi.h
библиотеки	Ntdsapi.lib
DLL	Ntdsapi.dll