DsReplicaGetInfoW 函数 (ntdsapi.h)

项目
03/13/2024

DsReplicaGetInfo 函数从目录服务检索复制状态数据。

语法

NTDSAPI DWORD DsReplicaGetInfoW(
  [in]           HANDLE            hDS,
  [in]           DS_REPL_INFO_TYPE InfoType,
  [in, optional] LPCWSTR           pszObject,
  [in, optional] UUID              *puuidForSourceDsaObjGuid,
  [out]          VOID              **ppInfo
);

参数

[in] hDS

包含从 DSBind 或 DSBindWithCred 函数获取的目录服务句柄。

[in] InfoType

包含 DS_REPL_INFO_TYPE 值之一，该值指定要检索的复制数据类型。此值还确定 在 ppInfo 中返回的结构类型。

此函数仅支持以下值。如果需要其他数据类型，则必须使用 DsReplicaGetInfo2 函数。

DS_REPL_INFO_NEIGHBORS

DS_REPL_INFO_CURSORS_FOR_NC

DS_REPL_INFO_METADATA_FOR_OBJ

DS_REPL_INFO_KCC_DSA_CONNECT_FAILURES

DS_REPL_INFO_KCC_DSA_LINK_FAILURES

DS_REPL_INFO_PENDING_OPS

[in, optional] pszObject

指向常量以 null 结尾的 Unicode 字符串的指针，该字符串标识要检索其复制数据的对象。此参数的含义取决于 InfoType 参数的值。下面是可能的值代码。

DS_REPL_INFO_NEIGHBORS

pszObject 标识为其请求复制邻居的命名上下文。

DS_REPL_INFO_CURSORS_FOR_NC

pszObject 标识为其请求复制游标的命名上下文。

DS_REPL_INFO_METADATA_FOR_OBJ

pszObject 标识为其请求复制元数据的对象。

DS_REPL_INFO_KCC_DSA_CONNECT_FAILURES

pszObject 必须为 NULL。

DS_REPL_INFO_KCC_DSA_LINK_FAILURES

pszObject 必须为 NULL。

DS_REPL_INFO_PENDING_OPS

pszObject 必须为 NULL。

[in, optional] puuidForSourceDsaObjGuid

指向标识特定复制源的 GUID 值的指针。如果此参数不为 NULL 且 InfoType 参数包含 DS_REPL_INFO_NEIGHBORS，则仅返回与目录中具有给定 objectGuid 的 nTDSDSA 对象对应的源的邻居数据。如果 NULL 或 InfoType 参数不是 DS_REPL_INFO_NEIGHBORS，则忽略此参数。

[out] ppInfo

接收所请求数据的结构指针的地址。 InfoType 参数的值确定此结构的格式。有关详细信息以及可能的 InfoType 值列表和相应的结构类型，请参阅 DS_REPL_INFO_TYPE。

当调用 DsReplicaFreeInfo 不再需要该内存时，调用方必须释放此内存。

返回值

如果成功，则返回 ERROR_SUCCESS ，否则返回 Win32 或 RPC 错误。下面是可能的错误代码。

要求

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