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

関数の動作を変更するフラグのセットが含まれます。 このパラメーターには、0 または次の値を指定できます。

DS_REPL_INFO_FLAG_IMPROVE_LINKED_ATTRS

属性のメタデータが、属性のリンクされた値のメタデータを考慮するようにします。 結果のベクターは、すべての属性の変更を表します。 この変更されたベクターは、すべての属性とメタデータを属性メタデータ ベクターに含める必要があるクライアントに役立ちます。

[in] dwEnumerationContext

取得する次のエントリのインデックスを格納します。 このパラメーターは、この関数が初めて呼び出されるときに 0 に設定する必要があります。

このパラメーターは、 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 パラメーターの値によって、この構造体の形式が決まります。 使用可能な インフォタイプ 値および対応する構造タイプの詳細と一覧については、 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