DsReplicaGetInfoW 函式 (ntdsapi.h)

發行項
03/05/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 不再需要此記憶體時，呼叫端必須釋放此記憶體。

傳回值

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

規格需求

需求	值
最低支援的用戶端	Windows Vista
最低支援的伺服器	Windows Server 2008
目標平台	Windows
標頭	ntdsapi.h
程式庫	Ntdsapi.lib
Dll	Ntdsapi.dll