DsReplicaGetInfoW 関数 (ntdsapi.h)
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 パラメーターの値によって、この構造体の形式が決まります。 使用可能な インフォタイプ 値および対応する構造タイプの詳細と一覧については、 DS_REPL_INFO_TYPEを参照してください。
DsReplicaFreeInfo を呼び出して不要になった場合、呼び出し元はこのメモリを解放する必要があります。
戻り値
成功した場合 はERROR_SUCCESS を返し、それ以外の場合は Win32 または RPC エラーを返します。 考えられるエラー コードを次に示します。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista |
サポートされている最小のサーバー | Windows Server 2008 |
対象プラットフォーム | Windows |
ヘッダー | ntdsapi.h |
Library | Ntdsapi.lib |
[DLL] | Ntdsapi.dll |