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。

DS_REPL_INFO_KCC_DSA_LINK_FAILURES

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 不再需要時，必須釋放此記憶體。

傳回值

如果成功或 Win32 或 RPC 錯誤，則傳回 ERROR_SUCCESS 否則傳回 。 以下是可能的錯誤碼。

規格需求

另請參閱

域控制器和復寫管理功能

DsBind

DsReplicaFreeInfo