DsReplicaGetInfo2W 函数 (ntdsapi.h)

  • 项目

DsReplicaGetInfo2 函数从目录服务检索复制状态数据。 此函数允许在检索超过 1000 个条目的情况下对结果进行分页。

语法

NTDSAPI DWORD DsReplicaGetInfo2W(
  [in]           HANDLE            hDS,
  [in]           DS_REPL_INFO_TYPE InfoType,
  [in, optional] LPCWSTR           pszObject,
  [in, optional] UUID              *puuidForSourceDsaObjGuid,
  [in, optional] LPCWSTR           pszAttributeName,
  [in, optional] LPCWSTR           pszValue,
  [in]           DWORD             dwFlags,
  [in]           DWORD             dwEnumerationContext,
  [out]          VOID              **ppInfo
);

参数

[in] hDS

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

[in] InfoType

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

[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。

pszObject 必须为 NULL。

DS_REPL_INFO_PENDING_OPS

pszObject 必须为 NULL。

DS_REPL_INFO_METADATA_FOR_ATTR_VALUE

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

DS_REPL_INFO_CURSORS_2_FOR_NC

DS_REPL_INFO_CURSORS_3_FOR_NC

DS_REPL_INFO_METADATA_2_FOR_OBJ

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

DS_REPL_INFO_METADATA_2_FOR_ATTR_VALUE

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

[in, optional] puuidForSourceDsaObjGuid

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

[in, optional] pszAttributeName

指向以 null 结尾的 Unicode 字符串的指针，该字符串包含要检索其复制数据的特定属性的名称。

仅当 InfoType 参数包含以下值之一时，才使用此参数。

DS_REPL_INFO_METADATA_FOR_ATTR_VALUE

DS_REPL_INFO_METADATA_2_FOR_ATTR_VALUE

[in, optional] pszValue

指向以 null 结尾的 Unicode 字符串的指针，该字符串包含要匹配的可分辨名称值。 如果请求的属性是可分辨名称类型值，则此函数返回包含指定值的属性。

[in] dwFlags

包含一组用于修改函数行为的标志。 此参数可以为零或以下值。

DS_REPL_INFO_FLAG_IMPROVE_LINKED_ATTRS

使属性元数据考虑属性链接值上的元数据。 生成的向量表示所有属性的更改。 此修改向量对于希望所有属性和元数据都包含在属性元数据向量中的客户端非常有用。

[in] dwEnumerationContext

包含要检索的下一个条目的索引。 首次调用此函数时，此参数必须设置为零。

仅当 InfoType 参数包含以下值之一时，才使用此参数。

DS_REPL_INFO_CURSORS_2_FOR_NC

DS_REPL_INFO_CURSORS_3_FOR_NC

DS_REPL_INFO_METADATA_FOR_ATTR_VALUE

DS_REPL_INFO_METADATA_2_FOR_ATTR_VALUE

此函数每次调用最多检索 1000 个条目。 如果在调用此函数后有更多的条目可用，则检索到的结构的 dwEnumerationContext 成员将包含下一个要检索的条目的索引。 然后在下一次调用此函数时，检索到的结构的 dwEnumerationContext 成员用作 dwEnumerationContext 参数。 检索所有条目后，检索到的结构的 dwEnumerationContext 成员将包含 -1。 如果为此参数传递了 -1，则此函数将返回 ERROR_NO_MORE_ITEMS。

[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

另请参阅

域控制器和复制管理功能

DsBind

DsReplicaFreeInfo