DsGetDomainControllerInfoA 関数 (ntdsapi.h)

[アーティクル]
03/05/2024

DsGetDomainControllerInfo 関数は、ドメイン内のドメインコントローラーに関するデータを取得します。

構文

NTDSAPI DWORD DsGetDomainControllerInfoA(
  [in]  HANDLE hDs,
  [in]  LPCSTR DomainName,
  [in]  DWORD  InfoLevel,
  [out] DWORD  *pcOut,
  [out] VOID   **ppInfo
);

パラメーター

[in] hDs

DSBind または DSBindWithCred 関数から取得したディレクトリサービスハンドルが含まれます。

[in] DomainName

ドメイン名を指定する null で終わる文字列へのポインター。

[in] InfoLevel

返される DS_DOMAIN_CONTROLLER_INFO 構造体のバージョンを示す値を格納します。次のいずれかの値を指定できます。

1

関数は、ドメインデータを DS_DOMAIN_CONTROLLER_INFO_1 構造体形式で提供します。

2

関数は、ドメインデータを DS_DOMAIN_CONTROLLER_INFO_2 構造体形式で提供します。

3

関数は、 DS_DOMAIN_CONTROLLER_INFO_3 構造形式でドメインデータを提供します。

[out] pcOut

ppInfo 配列で返される項目の数を受け取る DWORD 変数へのポインター。

[out] ppInfo

DS_DOMAIN_CONTROLLER_INFO_* 構造体の配列を受け取るポインター変数へのポインター。この配列内の構造体の型は 、InfoLevel パラメーターによって定義されます。呼び出し元は、 DsFreeDomainControllerInfo 関数を使用して、不要になったときにこの配列を解放する必要があります。

戻り値

関数がドメインコントローラーデータを返す場合、戻り値は ERROR_SUCCESS。呼び出し元にサーバーオブジェクトにアクセスする権限がない場合、戻り値は ERROR_SUCCESSされますが、 DS_DOMAIN_CONTROLLER_INFO 構造体は空である可能性があります。

関数が失敗した場合、戻り値には次のいずれかのエラーコードを指定できます。

注釈

注意

ntdsapi.h ヘッダーは、DSGetDomainControllerInfo をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows Vista
サポートされている最小のサーバー	Windows Server 2008
対象プラットフォーム	Windows
ヘッダー	ntdsapi.h
Library	Ntdsapi.lib
[DLL]	Ntdsapi.dll