Функция DsGetDomainControllerInfoA (ntdsapi.h)
Функция 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 |
Целевая платформа | Windows |
Header | ntdsapi.h |
Библиотека | Ntdsapi.lib |
DLL | Ntdsapi.dll |