DsGetDomainControllerInfoA 函数 (ntdsapi.h)

项目
08/25/2023

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

指向接收 ppInfo 数组中返回的项数的 DWORD 变量的指针。

[out] ppInfo

指向接收 DS_DOMAIN_CONTROLLER_INFO_* 结构的数组的指针变量的指针。此数组中的结构类型由 InfoLevel 参数定义。调用方必须使用 DsFreeDomainControllerInfo 函数释放此数组（如果不再需要该数组）。

返回值

如果函数返回域控制器数据，则返回值 ERROR_SUCCESS。如果调用方没有访问服务器对象的权限，则返回值为 ERROR_SUCCESS，但 DS_DOMAIN_CONTROLLER_INFO 结构可能为空。

如果函数失败，则返回值可能是以下错误代码之一。

注解

注意

ntdsapi.h 标头将 DsGetDomainControllerInfo 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。有关详细信息，请参阅函数原型的约定。

要求

要求	值
最低受支持的客户端	Windows Vista
最低受支持的服务器	Windows Server 2008
目标平台	Windows
标头	ntdsapi.h
Library	Ntdsapi.lib
DLL	Ntdsapi.dll