Win32 API 日本語リファレンス
ホーム › Networking.ActiveDirectory › DsGetDcNameW

DsGetDcNameW

関数
指定ドメインのドメインコントローラーを検出し情報を返す。
DLLNETAPI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// NETAPI32.dll  (Unicode / -W)
#include <windows.h>

DWORD DsGetDcNameW(
    LPCWSTR ComputerName,   // optional
    LPCWSTR DomainName,   // optional
    GUID* DomainGuid,   // optional
    LPCWSTR SiteName,   // optional
    DWORD Flags,
    DOMAIN_CONTROLLER_INFOW** DomainControllerInfo
);

パラメーター

名前型方向説明
ComputerNameLPCWSTRinoptionalこの関数を処理するサーバーの名前を指定する、null で終わる文字列へのポインターです。通常、このパラメーターは NULL であり、ローカルコンピューターが使用されることを示します。
DomainNameLPCWSTRinoptional

クエリ対象のドメインまたはアプリケーションパーティションの名前を指定する、null で終わる文字列へのポインターです。この名前には、DNS 形式の名前 (例: fabrikam.com) とフラット形式の名前 (例: Fabrikam) のどちらも指定できます。DNS 形式の名前を指定する場合、末尾のピリオドはあってもなくてもかまいません。

Flags パラメーターに DS_GC_SERVER_REQUIRED フラグが含まれる場合、DomainName はフォレストの名前でなければなりません。この場合、DomainName にフォレストルート以外の名前を指定すると DsGetDcName は失敗します。

Flags パラメーターに DS_GC_SERVER_REQUIRED フラグが含まれ、かつ DomainName が NULL の場合、DsGetDcName は ComputerName で示されるコンピューター (ComputerName が NULL の場合はローカルコンピューター) のフォレスト内でグローバルカタログを探します。

DomainName が NULL で、Flags パラメーターに DS_GC_SERVER_REQUIRED フラグが含まれない場合、ComputerName には、ComputerName で示されるコンピューターのプライマリドメインの既定のドメイン名が設定されます。

DomainGuidGUID*inoptionalクエリ対象のドメインの GUID を指定する GUID 構造体へのポインターです。DomainGuid が NULL ではなく、DomainName または ComputerName で指定されたドメインが見つからない場合、DsGetDcName は DomainGuid で指定された GUID を持つドメイン内のドメインコントローラーを探します。
SiteNameLPCWSTRinoptional返されるドメインコントローラーが物理的に存在すべきサイトの名前を指定する、null で終わる文字列へのポインターです。このパラメーターが NULL の場合、DsGetDcName は ComputerName で指定されたコンピューターのサイトに最も近いサイトのドメインコントローラーを返そうとします。このパラメーターは、既定では NULL にしてください。
FlagsDWORDin

要求の処理に使用される追加データを提供する一連のフラグを指定します。このパラメーターには、次の値を組み合わせて指定できます。

DS_AVOID_SELF

ドメインコントローラーから呼び出された場合に、返されるドメインコントローラー名が現在のコンピューター自身にならないように指定します。現在のコンピューターがドメインコントローラーでない場合、このフラグは無視されます。このフラグは、ドメイン内の別のドメインコントローラーの名前を取得するために使用できます。

DS_BACKGROUND_ONLY

DS_FORCE_REDISCOVERY フラグが指定されていない場合、この関数はキャッシュされたドメインコントローラーのデータを使用します。キャッシュされたデータが 15 分より古い場合は、ドメインコントローラーに ping を送信してキャッシュが更新されます。このフラグを指定すると、キャッシュされたデータの有効期限が切れていても、この更新は行われません。DsGetDcName 関数を定期的に呼び出す場合は、このフラグを使用してください。

DS_DIRECTORY_SERVICE_PREFERRED

DsGetDcName は、ディレクトリサービスの機能をサポートするドメインコントローラーを探します。ディレクトリサービスをサポートするドメインコントローラーが利用できない場合、DsGetDcName はディレクトリサービス非対応のドメインコントローラーの名前を返します。ただし、DsGetDcName がディレクトリサービス非対応のドメインコントローラーを返すのは、ディレクトリサービス対応のドメインコントローラーの検索がタイムアウトした後だけです。

DS_DIRECTORY_SERVICE_REQUIRED

返されるドメインコントローラーがディレクトリサービスをサポートしていることを必須にします。

DS_DIRECTORY_SERVICE_6_REQUIRED

返されるドメインコントローラーが Windows Server 2008 以降を実行していることを必須にします。

DS_DIRECTORY_SERVICE_8_REQUIRED

返されるドメインコントローラーが Windows Server 2012 以降を実行していることを必須にします。

DS_FORCE_REDISCOVERY

キャッシュされたドメインコントローラーのデータを強制的に無視します。DS_FORCE_REDISCOVERY フラグが指定されていない場合、DsGetDcName はキャッシュされたドメインコントローラーのデータを返すことがあります。このフラグを指定すると、DsGetDcName はキャッシュされた情報 (存在する場合) を使用せず、ドメインコントローラーの検出をあらためて実行します。

キャッシュされたドメインコントローラー情報を使用する方がパフォーマンス特性に優れ、すべてのアプリケーションが一貫して同じドメインコントローラーを使用できるようになるため、通常の状況ではこのフラグを使用しないでください。このフラグは、このフラグを指定せずに呼び出した DsGetDcName が返したドメインコントローラーにアクセスできないとアプリケーションが判断した場合にのみ使用してください。その場合、アプリケーションはこのフラグを指定して DsGetDcName を再度呼び出し、役に立たないキャッシュ情報 (存在する場合) が無視され、到達可能なドメインコントローラーが検出されるようにします。

DS_GC_SERVER_REQUIRED

返されるドメインコントローラーが、このドメインをルートとするドメインフォレストのグローバルカタログサーバーであることを必須にします。このフラグが設定され、かつ DomainName パラメーターが NULL でない場合、DomainName にはフォレスト名を指定する必要があります。このフラグは DS_PDC_REQUIRED フラグまたは DS_KDC_REQUIRED フラグと組み合わせることはできません。

DS_GOOD_TIMESERV_PREFERRED

DsGetDcName は、信頼できるタイムサーバーであるドメインコントローラーを探します。Windows Time Service は、1 つ以上のドメインコントローラーを信頼できるタイムサーバーとして宣言するように構成できます。詳細については、Windows Time Service のドキュメントを参照してください。このフラグは、Windows Time Service だけが使用することを想定しています。

DS_IP_REQUIRED

このパラメーターは、ドメインコントローラーが IP アドレスを持っている必要があることを示します。その場合、DsGetDcName はドメインコントローラーのインターネットプロトコルアドレスを DomainControllerInfo の DomainControllerAddress メンバーに格納します。

DS_IS_DNS_NAME

DomainName パラメーターが DNS 名であることを指定します。このフラグは DS_IS_FLAT_NAME フラグと組み合わせることはできません。

DS_IS_DNS_NAME と DS_IS_FLAT_NAME のいずれかを指定してください。どちらのフラグも指定しない場合、DsGetDcName は DNS 形式の名前とフラット名の両方を検索する必要があるため、ドメインコントローラーの検出により時間がかかることがあります。

DS_IS_FLAT_NAME

DomainName パラメーターがフラット名であることを指定します。このフラグは DS_IS_DNS_NAME フラグと組み合わせることはできません。

DS_KDC_REQUIRED

返されるドメインコントローラーが現在 Kerberos Key Distribution Center サービスを実行していることを必須にします。このフラグは DS_PDC_REQUIRED フラグまたは DS_GC_SERVER_REQUIRED フラグと組み合わせることはできません。

DS_ONLY_LDAP_NEEDED

返されるサーバーが LDAP サーバーであることを指定します。返されるサーバーは必ずしもドメインコントローラーではありません。そのサーバーに他のサービスが存在することも意味しません。返されるサーバーは、書き込み可能な config コンテナーや書き込み可能な schema コンテナーを必ずしも持ちません。また、返されるサーバーはセキュリティプリンシパルの作成や変更に使用できるとは限りません。このフラグは DS_GC_SERVER_REQUIRED フラグと併用して、グローバルカタログサーバーも兼ねる LDAP サーバーを返すことができます。返されるグローバルカタログサーバーは必ずしもドメインコントローラーではありません。そのサーバーに他のサービスが存在することも意味しません。このフラグを指定した場合、DS_PDC_REQUIRED、DS_TIMESERV_REQUIRED、DS_GOOD_TIMESERV_PREFERRED、DS_DIRECTORY_SERVICES_PREFERED、DS_DIRECTORY_SERVICES_REQUIRED、DS_KDC_REQUIRED の各フラグは無視されます。

DS_PDC_REQUIRED

返されるドメインコントローラーが、そのドメインのプライマリドメインコントローラーであることを必須にします。このフラグは DS_KDC_REQUIRED フラグまたは DS_GC_SERVER_REQUIRED フラグと組み合わせることはできません。

DS_RETURN_DNS_NAME

DomainControllerInfo の DomainControllerName メンバーおよび DomainName メンバーで返される名前が DNS 名であることを指定します。DNS 名が利用できない場合はエラーが返されます。このフラグは DS_RETURN_FLAT_NAME フラグと同時に指定することはできません。このフラグは DS_IP_REQUIRED フラグを暗黙的に含みます。

DS_RETURN_FLAT_NAME

DomainControllerInfo の DomainControllerName メンバーおよび DomainName メンバーで返される名前がフラット名であることを指定します。フラット名が利用できない場合はエラーが返されます。このフラグは DS_RETURN_DNS_NAME フラグと同時に指定することはできません。

DS_TIMESERV_REQUIRED

返されるドメインコントローラーが現在 Windows Time Service を実行していることを必須にします。

DS_TRY_NEXTCLOSEST_SITE

このフラグを指定すると、DsGetDcName は呼び出し元と同じサイトにあるドメインコントローラーを探します。該当するドメインコントローラーが見つからない場合は、トポロジ情報を提供できるドメインコントローラーを見つけて DsBindToISTG を呼び出してバインドハンドルを取得し、次に DsQuerySitesByCost を UDP 経由で呼び出して「次に近いサイト」を判定し、最後に見つかったサイトの名前をキャッシュします。そのサイトにドメインコントローラーが見つからない場合、DsGetDcName はドメインコントローラーを検索する既定の方法にフォールバックします。

このフラグを、入力パラメーター SiteName に NULL 以外の値を指定して併用した場合は、ERROR_INVALID_FLAGS がスローされます。

また、DS_TRY_NEXT_CLOSEST_SITE で行われる検索はサイト固有であるため、このフラグを DS_PDC_REQUIRED と併用した場合は無視されます。さらに、DS_TRY_NEXTCLOSEST_SITE を DS_RETURN_FLAT_NAME と併用した場合も無視されます。これは、DS_RETURN_FLAT_NAME が名前の解決に NetBIOS を使用するため、見つかったドメインコントローラーのドメインが、クライアントの参加先ドメインと必ずしも一致しないためです。

Note このフラグはグループポリシーに対応しています。「Next Closest Site」ポリシー設定を有効にすると、構成されていない利用可能なすべてのネットワークアダプターにおいて、そのコンピューターで Next Closest Site の DC 検索が有効になります。このポリシー設定を無効にすると、構成されていない利用可能なすべてのネットワークアダプターにおいて、そのコンピューターで Next Closest Site の DC 検索は既定では使用されません。ただし、DS_TRY_NEXTCLOSEST_SITE フラグを明示的に指定して DC Locator を呼び出した場合、DsGetDcName は Next Closest Site の動作に従います。このポリシー設定を構成しない場合、構成されていない利用可能なすべてのネットワークアダプターにおいて、そのコンピューターで Next Closest Site の DC 検索は既定では使用されません。DS_TRY_NEXTCLOSEST_SITE フラグを明示的に指定した場合は、Next Closest Site の動作が使用されます。

DS_WRITABLE_REQUIRED

返されるドメインコントローラーが書き込み可能であること、すなわちディレクトリサービスの書き込み可能なコピーをホストしていることを必須にします。

DS_WEB_SERVICE_REQUIRED

返されるドメインコントローラーが現在 Active Directory Web サービスを実行していることを必須にします。

DomainControllerInfoDOMAIN_CONTROLLER_INFOW**out

選択されたドメインコントローラーに関するデータを格納する DOMAIN_CONTROLLER_INFO 構造体へのポインターを受け取る PDOMAIN_CONTROLLER_INFO 値へのポインターです。この構造体は DsGetDcName によって割り当てられます。呼び出し元は、不要になった時点で NetApiBufferFree 関数を使用してこの構造体を解放する必要があります。

- Flags.DS_AVOID_SELF

ドメインコントローラーから呼び出された場合に、返されるドメインコントローラー名が現在のコンピューター自身にならないように指定します。現在のコンピューターがドメインコントローラーでない場合、このフラグは無視されます。このフラグは、ドメイン内の別のドメインコントローラーの名前を取得するために使用できます。

- Flags.DS_BACKGROUND_ONLY

DS_FORCE_REDISCOVERY フラグが指定されていない場合、この関数はキャッシュされたドメインコントローラーのデータを使用します。キャッシュされたデータが 15 分より古い場合は、ドメインコントローラーに ping を送信してキャッシュが更新されます。このフラグを指定すると、キャッシュされたデータの有効期限が切れていても、この更新は行われません。DsGetDcName 関数を定期的に呼び出す場合は、このフラグを使用してください。

- Flags.DS_DIRECTORY_SERVICE_6_REQUIRED

返されるドメインコントローラーが Windows Server 2008 以降を実行していることを必須にします。

- Flags.DS_DIRECTORY_SERVICE_8_REQUIRED

返されるドメインコントローラーが Windows Server 2012 以降を実行していることを必須にします。

- Flags.DS_DIRECTORY_SERVICE_PREFERRED

DsGetDcName は、ディレクトリサービスの機能をサポートするドメインコントローラーを探します。ディレクトリサービスをサポートするドメインコントローラーが利用できない場合、DsGetDcName はディレクトリサービス非対応のドメインコントローラーの名前を返します。ただし、DsGetDcName がディレクトリサービス非対応のドメインコントローラーを返すのは、ディレクトリサービス対応のドメインコントローラーの検索がタイムアウトした後だけです。

- Flags.DS_DIRECTORY_SERVICE_REQUIRED

返されるドメインコントローラーがディレクトリサービスをサポートしていることを必須にします。

- Flags.DS_FORCE_REDISCOVERY

キャッシュされたドメインコントローラーのデータを強制的に無視します。DS_FORCE_REDISCOVERY フラグが指定されていない場合、DsGetDcName はキャッシュされたドメインコントローラーのデータを返すことがあります。このフラグを指定すると、DsGetDcName はキャッシュされた情報 (存在する場合) を使用せず、ドメインコントローラーの検出をあらためて実行します。

キャッシュされたドメインコントローラー情報を使用する方がパフォーマンス特性に優れ、すべてのアプリケーションが一貫して同じドメインコントローラーを使用できるようになるため、通常の状況ではこのフラグを使用しないでください。このフラグは、このフラグを指定せずに呼び出した DsGetDcName が返したドメインコントローラーにアクセスできないとアプリケーションが判断した場合にのみ使用してください。その場合、アプリケーションはこのフラグを指定して DsGetDcName を再度呼び出し、役に立たないキャッシュ情報 (存在する場合) が無視され、到達可能なドメインコントローラーが検出されるようにします。

- Flags.DS_GC_SERVER_REQUIRED

返されるドメインコントローラーが、このドメインをルートとするドメインフォレストのグローバルカタログサーバーであることを必須にします。このフラグが設定され、かつ DomainName パラメーターが NULL でない場合、DomainName にはフォレスト名を指定する必要があります。このフラグは DS_PDC_REQUIRED フラグまたは DS_KDC_REQUIRED フラグと組み合わせることはできません。

- Flags.DS_GOOD_TIMESERV_PREFERRED

DsGetDcName は、信頼できるタイムサーバーであるドメインコントローラーを探します。Windows Time Service は、1 つ以上のドメインコントローラーを信頼できるタイムサーバーとして宣言するように構成できます。詳細については、Windows Time Service のドキュメントを参照してください。このフラグは、Windows Time Service だけが使用することを想定しています。

- Flags.DS_IP_REQUIRED

このパラメーターは、ドメインコントローラーが IP アドレスを持っている必要があることを示します。その場合、DsGetDcName はドメインコントローラーのインターネットプロトコルアドレスを DomainControllerInfo の DomainControllerAddress メンバーに格納します。

- Flags.DS_IS_DNS_NAME

DomainName パラメーターが DNS 名であることを指定します。このフラグは DS_IS_FLAT_NAME フラグと組み合わせることはできません。

DS_IS_DNS_NAME と DS_IS_FLAT_NAME のいずれかを指定してください。どちらのフラグも指定しない場合、DsGetDcName は DNS 形式の名前とフラット名の両方を検索する必要があるため、ドメインコントローラーの検出により時間がかかることがあります。

- Flags.DS_IS_FLAT_NAME

DomainName パラメーターがフラット名であることを指定します。このフラグは DS_IS_DNS_NAME フラグと組み合わせることはできません。

- Flags.DS_KDC_REQUIRED

返されるドメインコントローラーが現在 Kerberos Key Distribution Center サービスを実行していることを必須にします。このフラグは DS_PDC_REQUIRED フラグまたは DS_GC_SERVER_REQUIRED フラグと組み合わせることはできません。

- Flags.DS_ONLY_LDAP_NEEDED

返されるサーバーが LDAP サーバーであることを指定します。返されるサーバーは必ずしもドメインコントローラーではありません。そのサーバーに他のサービスが存在することも意味しません。返されるサーバーは、書き込み可能な config コンテナーや書き込み可能な schema コンテナーを必ずしも持ちません。また、返されるサーバーはセキュリティプリンシパルの作成や変更に使用できるとは限りません。このフラグは DS_GC_SERVER_REQUIRED フラグと併用して、グローバルカタログサーバーも兼ねる LDAP サーバーを返すことができます。返されるグローバルカタログサーバーは必ずしもドメインコントローラーではありません。そのサーバーに他のサービスが存在することも意味しません。このフラグを指定した場合、DS_PDC_REQUIRED、DS_TIMESERV_REQUIRED、DS_GOOD_TIMESERV_PREFERRED、DS_DIRECTORY_SERVICES_PREFERED、DS_DIRECTORY_SERVICES_REQUIRED、DS_KDC_REQUIRED の各フラグは無視されます。

- Flags.DS_PDC_REQUIRED

返されるドメインコントローラーが、そのドメインのプライマリドメインコントローラーであることを必須にします。このフラグは DS_KDC_REQUIRED フラグまたは DS_GC_SERVER_REQUIRED フラグと組み合わせることはできません。

- Flags.DS_RETURN_DNS_NAME

DomainControllerInfo の DomainControllerName メンバーおよび DomainName メンバーで返される名前が DNS 名であることを指定します。DNS 名が利用できない場合はエラーが返されます。このフラグは DS_RETURN_FLAT_NAME フラグと同時に指定することはできません。このフラグは DS_IP_REQUIRED フラグを暗黙的に含みます。

- Flags.DS_RETURN_FLAT_NAME

DomainControllerInfo の DomainControllerName メンバーおよび DomainName メンバーで返される名前がフラット名であることを指定します。フラット名が利用できない場合はエラーが返されます。このフラグは DS_RETURN_DNS_NAME フラグと同時に指定することはできません。

- Flags.DS_TIMESERV_REQUIRED

返されるドメインコントローラーが現在 Windows Time Service を実行していることを必須にします。

- Flags.DS_TRY_NEXTCLOSEST_SITE

このフラグを指定すると、DsGetDcName は呼び出し元と同じサイトにあるドメインコントローラーを探します。該当するドメインコントローラーが見つからない場合は、トポロジ情報を提供できるドメインコントローラーを見つけて DsBindToISTG を呼び出してバインドハンドルを取得し、次に DsQuerySitesByCost を UDP 経由で呼び出して「次に近いサイト」を判定し、最後に見つかったサイトの名前をキャッシュします。そのサイトにドメインコントローラーが見つからない場合、DsGetDcName はドメインコントローラーを検索する既定の方法にフォールバックします。

このフラグを、入力パラメーター SiteName に NULL 以外の値を指定して併用した場合は、ERROR_INVALID_FLAGS がスローされます。

また、DS_TRY_NEXT_CLOSEST_SITE で行われる検索はサイト固有であるため、このフラグを DS_PDC_REQUIRED と併用した場合は無視されます。さらに、DS_TRY_NEXTCLOSEST_SITE を DS_RETURN_FLAT_NAME と併用した場合も無視されます。これは、DS_RETURN_FLAT_NAME が名前の解決に NetBIOS を使用するため、見つかったドメインコントローラーのドメインが、クライアントの参加先ドメインと必ずしも一致しないためです。

Note このフラグはグループポリシーに対応しています。「Next Closest Site」ポリシー設定を有効にすると、構成されていない利用可能なすべてのネットワークアダプターにおいて、そのコンピューターで Next Closest Site の DC 検索が有効になります。このポリシー設定を無効にすると、構成されていない利用可能なすべてのネットワークアダプターにおいて、そのコンピューターで Next Closest Site の DC 検索は既定では使用されません。ただし、DS_TRY_NEXTCLOSEST_SITE フラグを明示的に指定して DC Locator を呼び出した場合、DsGetDcName は Next Closest Site の動作に従います。このポリシー設定を構成しない場合、構成されていない利用可能なすべてのネットワークアダプターにおいて、そのコンピューターで Next Closest Site の DC 検索は既定では使用されません。DS_TRY_NEXTCLOSEST_SITE フラグを明示的に指定した場合は、Next Closest Site の動作が使用されます。
- Flags.DS_WEB_SERVICE_REQUIRED

返されるドメインコントローラーが現在 Active Directory Web サービスを実行していることを必須にします。

- Flags.DS_WRITABLE_REQUIRED

返されるドメインコントローラーが書き込み可能であること、すなわちディレクトリサービスの書き込み可能なコピーをホストしていることを必須にします。

戻り値の型: DWORD

公式ドキュメント

指定したドメイン内のドメインコントローラーの名前を返します。(Unicode)

戻り値

関数がドメインコントローラーのデータを返した場合、戻り値は ERROR_SUCCESS です。

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

解説(Remarks)

DsGetDcName 関数は、ComputerName で指定されたリモートコンピューター上の Netlogon サービスに送信されます。ComputerName が NULL の場合、この関数はローカルコンピューター上で処理されます。

DsGetDcName は、返されたドメインコントローラー名が実際のドメインコントローラーまたはグローバルカタログの名前であることを検証しません。相互認証が必要な場合は、呼び出し元が認証を行う必要があります。

DsGetDcName は、指定されたドメインに対する特定のアクセス権を必要としません。既定では、この関数は返されたドメインコントローラーが現在利用可能であることを保証しません。呼び出し元は、返されたドメインコントローラーを実際に使用してみてください。ドメインコントローラーが利用できない場合、呼び出し元は DS_FORCE_REDISCOVERY フラグを指定して DsGetDcName 関数を再度呼び出してください。

応答時間

DsGetDcName を使用する際は、次のタイミングに関する点に注意してください。

ドメインコントローラーのスティッキネスに関する注意

Active Directory ドメインサービスでは、ドメインコントローラーロケーター機能は、クライアントが優先するドメインコントローラーを一度見つけると、そのドメインコントローラーが応答しなくなるか、クライアントが再起動されない限り、別のドメインコントローラーを探さないように設計されています。これは「ドメインコントローラーのスティッキネス」と呼ばれます。ワークステーションは通常、問題や再起動なしに数か月間動作し続けるため、この動作の意図しない結果として、特定のドメインコントローラーが保守のために停止すると、それに接続していたすべてのクライアントは接続先を別のドメインコントローラーに切り替えます。しかし、そのドメインコントローラーが復旧しても、クライアントはめったに再起動しないため、どのクライアントも再接続しません。これは負荷分散の問題を引き起こす可能性があります。

以前は、この問題に対する最も一般的な解決策は、DS_FORCE_REDISCOVERY フラグを指定して DsGetDcName を定期的に呼び出すスクリプトを各クライアントコンピューターに展開することでした。これはやや煩雑な解決策であったため、Windows Server 2008 および Windows Vista では、ドメインコントローラーのスティッキネスの問題に対処する新しいメカニズムが導入されました。

DsGetDcName は、キャッシュからドメインコントローラー名を取得するたびに、そのキャッシュエントリの有効期限が切れていないかを確認し、切れている場合はそのドメインコントローラー名を破棄して、ドメインコントローラー名の再検出を試みます。キャッシュエントリの有効期間は、次のレジストリキーの値によって制御されます。

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Netlogon\Parameters\ForceRediscoveryInterval

および

HKEY_LOCAL_MACHINE\Software\Policies\Microsoft\Netlogon\Parameters\ForceRediscoveryInterval

これらのレジストリキーの値は REG_DWORD 型です。値には、DsGetDcName がドメインコントローラー名の再検出を試みるまでの秒数を指定します。既定値は 43200 秒 (12 時間) です。ForceRediscoveryInterval レジストリエントリの値を 0 に設定すると、クライアントは常に再検出を行います。値を 4294967295 に設定すると、キャッシュは期限切れにならず、キャッシュされたドメインコントローラーが引き続き使用されます。ForceRediscoveryInterval レジストリエントリには、3600 秒 (60 分) 未満の値を設定しないことをお勧めします。

Note ForceRediscoveryInterval のレジストリ設定はグループポリシーに対応しています。このポリシー設定を無効にすると、そのコンピューターでは既定で 12 時間ごとに強制再検出が行われます。このポリシー設定を構成しない場合も、レジストリのローカルコンピューター設定が異なる値でない限り、既定で 12 時間ごとに強制再検出が行われます。
なお、DS_BACKGROUND_ONLY フラグを指定した場合、DsGetDcName はドメインコントローラー名の再検出を試みません。これは、このフラグの目的が、有効期限が切れていてもキャッシュされたドメインコントローラー名を DsGetDcName に強制的に使用させることだからです。

DsGetDcName における ETW トレース

DsGetDcName の ETW トレースを有効にするには、次のレジストリキーを作成します。

HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\DCLocator\Tracing

このキーは次のような構造になります。

String ProcessName
  DWORD  PID <optional>

ProcessName には、トレース情報を取得したいプロセスの、拡張子を含む完全な名前を指定する必要があります。PID は、同じ名前のプロセスが複数存在する場合にのみ必要です。PID を定義すると、その PID を持つプロセスだけがトレースの対象になります。同じ名前を持つ 3 つ (またはそれ以上) のプロセスのうち 2 つだけをトレースすることはできません。有効にできるのは 1 つのインスタンスまたはすべてのインスタンスです (同じプロセス名のインスタンスが複数存在し、PID が指定されていない場合は、すべてのインスタンスがトレースの対象になります)。

たとえば次の例では、App1.exe と App2.exe のすべてのインスタンスをトレースしますが、App3.exe については PID が 999 のインスタンスのみをトレースします。

App1.exe 
App2.exe
App3.exe
     PID 999

トレースセッションを開始するには、次のコマンドを実行します。

tracelog.exe -start <sessionname> -guid #cfaa5446-c6c4-4f5c-866f-31c9b55b962d -f <filename> -flag <traceFlags>

sessionname は、トレースセッションに付ける名前です。DCLocator トレースプロバイダーの guid は "cfaa5446-c6c4-4f5c-866f-31c9b55b962d" です。filename は、イベントの書き込み先となるログファイルの名前です。traceFlags は、トレースする領域を示す次のフラグの 1 つ以上です。

フラグ 16 進値 説明
DCLOCATOR_MISC 0x00000002 その他のデバッグ情報
DCLOCATOR_MAILSLOT 0x00000010 メールスロットメッセージ
DCLOCATOR_SITE 0x00000020 サイト
DCLOCATOR_CRITICAL 0x00000100 重大なエラー
DCLOCATOR_SESSION_SETUP 0x00000200 信頼されたドメインの保守
DCLOCATOR_DNS 0x00004000 名前の登録
DCLOCATOR_DNS_MORE 0x00020000 名前の登録 (詳細)
DCLOCATOR_MAILBOX_TEXT 0x02000000 メールボックスメッセージ (詳細)
DCLOCATOR_SITE_MORE 0x08000000 サイト (詳細)

トレースセッションを停止するには、次のコマンドを実行します。

tracelog.exe -stop <sessionname>

sessionname には、セッションを開始したときに使用した名前と同じ名前を指定します。

Note トレース対象のプロセスに対応するレジストリキーは、トレースセッションの開始時点でレジストリに存在している必要があります。セッションが開始されると、プロセスは (そのプロセス名および省略可能な PID に対応するレジストリキーの有無に基づいて) トレースメッセージを生成すべきかどうかを確認します。プロセスがレジストリを確認するのはセッションの開始時のみです。それ以降にレジストリを変更しても、トレースには影響しません。
メモ

dsgetdc.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして DsGetDcName を定義します。エンコーディングに依存しないエイリアスと、エンコーディングに依存するコードを混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則 を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// NETAPI32.dll  (Unicode / -W)
#include <windows.h>

DWORD DsGetDcNameW(
    LPCWSTR ComputerName,   // optional
    LPCWSTR DomainName,   // optional
    GUID* DomainGuid,   // optional
    LPCWSTR SiteName,   // optional
    DWORD Flags,
    DOMAIN_CONTROLLER_INFOW** DomainControllerInfo
);
[DllImport("NETAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint DsGetDcNameW(
    [MarshalAs(UnmanagedType.LPWStr)] string ComputerName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string DomainName,   // LPCWSTR optional
    IntPtr DomainGuid,   // GUID* optional
    [MarshalAs(UnmanagedType.LPWStr)] string SiteName,   // LPCWSTR optional
    uint Flags,   // DWORD
    IntPtr DomainControllerInfo   // DOMAIN_CONTROLLER_INFOW** out
);
<DllImport("NETAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function DsGetDcNameW(
    <MarshalAs(UnmanagedType.LPWStr)> ComputerName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> DomainName As String,   ' LPCWSTR optional
    DomainGuid As IntPtr,   ' GUID* optional
    <MarshalAs(UnmanagedType.LPWStr)> SiteName As String,   ' LPCWSTR optional
    Flags As UInteger,   ' DWORD
    DomainControllerInfo As IntPtr   ' DOMAIN_CONTROLLER_INFOW** out
) As UInteger
End Function
' ComputerName : LPCWSTR optional
' DomainName : LPCWSTR optional
' DomainGuid : GUID* optional
' SiteName : LPCWSTR optional
' Flags : DWORD
' DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out
Declare PtrSafe Function DsGetDcNameW Lib "netapi32" ( _
    ByVal ComputerName As LongPtr, _
    ByVal DomainName As LongPtr, _
    ByVal DomainGuid As LongPtr, _
    ByVal SiteName As LongPtr, _
    ByVal Flags As Long, _
    ByVal DomainControllerInfo As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DsGetDcNameW = ctypes.windll.netapi32.DsGetDcNameW
DsGetDcNameW.restype = wintypes.DWORD
DsGetDcNameW.argtypes = [
    wintypes.LPCWSTR,  # ComputerName : LPCWSTR optional
    wintypes.LPCWSTR,  # DomainName : LPCWSTR optional
    ctypes.c_void_p,  # DomainGuid : GUID* optional
    wintypes.LPCWSTR,  # SiteName : LPCWSTR optional
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_void_p,  # DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
DsGetDcNameW = Fiddle::Function.new(
  lib['DsGetDcNameW'],
  [
    Fiddle::TYPE_VOIDP,  # ComputerName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # DomainName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # DomainGuid : GUID* optional
    Fiddle::TYPE_VOIDP,  # SiteName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "netapi32")]
extern "system" {
    fn DsGetDcNameW(
        ComputerName: *const u16,  // LPCWSTR optional
        DomainName: *const u16,  // LPCWSTR optional
        DomainGuid: *mut GUID,  // GUID* optional
        SiteName: *const u16,  // LPCWSTR optional
        Flags: u32,  // DWORD
        DomainControllerInfo: *mut *mut DOMAIN_CONTROLLER_INFOW  // DOMAIN_CONTROLLER_INFOW** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NETAPI32.dll", CharSet = CharSet.Unicode)]
public static extern uint DsGetDcNameW([MarshalAs(UnmanagedType.LPWStr)] string ComputerName, [MarshalAs(UnmanagedType.LPWStr)] string DomainName, IntPtr DomainGuid, [MarshalAs(UnmanagedType.LPWStr)] string SiteName, uint Flags, IntPtr DomainControllerInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_DsGetDcNameW' -Namespace Win32 -PassThru
# $api::DsGetDcNameW(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
#uselib "NETAPI32.dll"
#func global DsGetDcNameW "DsGetDcNameW" wptr, wptr, wptr, wptr, wptr, wptr
; DsGetDcNameW ComputerName, DomainName, varptr(DomainGuid), SiteName, Flags, varptr(DomainControllerInfo)   ; 戻り値は stat
; ComputerName : LPCWSTR optional -> "wptr"
; DomainName : LPCWSTR optional -> "wptr"
; DomainGuid : GUID* optional -> "wptr"
; SiteName : LPCWSTR optional -> "wptr"
; Flags : DWORD -> "wptr"
; DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "NETAPI32.dll"
#cfunc global DsGetDcNameW "DsGetDcNameW" wstr, wstr, var, wstr, int, var
; res = DsGetDcNameW(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
; ComputerName : LPCWSTR optional -> "wstr"
; DomainName : LPCWSTR optional -> "wstr"
; DomainGuid : GUID* optional -> "var"
; SiteName : LPCWSTR optional -> "wstr"
; Flags : DWORD -> "int"
; DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD DsGetDcNameW(LPCWSTR ComputerName, LPCWSTR DomainName, GUID* DomainGuid, LPCWSTR SiteName, DWORD Flags, DOMAIN_CONTROLLER_INFOW** DomainControllerInfo)
#uselib "NETAPI32.dll"
#cfunc global DsGetDcNameW "DsGetDcNameW" wstr, wstr, var, wstr, int, var
; res = DsGetDcNameW(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
; ComputerName : LPCWSTR optional -> "wstr"
; DomainName : LPCWSTR optional -> "wstr"
; DomainGuid : GUID* optional -> "var"
; SiteName : LPCWSTR optional -> "wstr"
; Flags : DWORD -> "int"
; DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procDsGetDcNameW = netapi32.NewProc("DsGetDcNameW")
)

// ComputerName (LPCWSTR optional), DomainName (LPCWSTR optional), DomainGuid (GUID* optional), SiteName (LPCWSTR optional), Flags (DWORD), DomainControllerInfo (DOMAIN_CONTROLLER_INFOW** out)
r1, _, err := procDsGetDcNameW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ComputerName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(DomainName))),
	uintptr(DomainGuid),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(SiteName))),
	uintptr(Flags),
	uintptr(DomainControllerInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DsGetDcNameW(
  ComputerName: PWideChar;   // LPCWSTR optional
  DomainName: PWideChar;   // LPCWSTR optional
  DomainGuid: PGUID;   // GUID* optional
  SiteName: PWideChar;   // LPCWSTR optional
  Flags: DWORD;   // DWORD
  DomainControllerInfo: Pointer   // DOMAIN_CONTROLLER_INFOW** out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'DsGetDcNameW';
result := DllCall("NETAPI32\DsGetDcNameW"
    , "WStr", ComputerName   ; LPCWSTR optional
    , "WStr", DomainName   ; LPCWSTR optional
    , "Ptr", DomainGuid   ; GUID* optional
    , "WStr", SiteName   ; LPCWSTR optional
    , "UInt", Flags   ; DWORD
    , "Ptr", DomainControllerInfo   ; DOMAIN_CONTROLLER_INFOW** out
    , "UInt")   ; return: DWORD
●DsGetDcNameW(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo) = DLL("NETAPI32.dll", "dword DsGetDcNameW(char*, char*, void*, char*, dword, void*)")
# 呼び出し: DsGetDcNameW(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
# ComputerName : LPCWSTR optional -> "char*"
# DomainName : LPCWSTR optional -> "char*"
# DomainGuid : GUID* optional -> "void*"
# SiteName : LPCWSTR optional -> "char*"
# Flags : DWORD -> "dword"
# DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "netapi32" fn DsGetDcNameW(
    ComputerName: [*c]const u16, // LPCWSTR optional
    DomainName: [*c]const u16, // LPCWSTR optional
    DomainGuid: [*c]GUID, // GUID* optional
    SiteName: [*c]const u16, // LPCWSTR optional
    Flags: u32, // DWORD
    DomainControllerInfo: [*c][*c]DOMAIN_CONTROLLER_INFOW // DOMAIN_CONTROLLER_INFOW** out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc DsGetDcNameW(
    ComputerName: WideCString,  # LPCWSTR optional
    DomainName: WideCString,  # LPCWSTR optional
    DomainGuid: ptr GUID,  # GUID* optional
    SiteName: WideCString,  # LPCWSTR optional
    Flags: uint32,  # DWORD
    DomainControllerInfo: ptr DOMAIN_CONTROLLER_INFOW  # DOMAIN_CONTROLLER_INFOW** out
): uint32 {.importc: "DsGetDcNameW", stdcall, dynlib: "NETAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "netapi32");
extern(Windows)
uint DsGetDcNameW(
    const(wchar)* ComputerName,   // LPCWSTR optional
    const(wchar)* DomainName,   // LPCWSTR optional
    GUID* DomainGuid,   // GUID* optional
    const(wchar)* SiteName,   // LPCWSTR optional
    uint Flags,   // DWORD
    DOMAIN_CONTROLLER_INFOW** DomainControllerInfo   // DOMAIN_CONTROLLER_INFOW** out
);
ccall((:DsGetDcNameW, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, Cwstring, Ptr{GUID}, Cwstring, UInt32, Ptr{DOMAIN_CONTROLLER_INFOW}),
      ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
# ComputerName : LPCWSTR optional -> Cwstring
# DomainName : LPCWSTR optional -> Cwstring
# DomainGuid : GUID* optional -> Ptr{GUID}
# SiteName : LPCWSTR optional -> Cwstring
# Flags : DWORD -> UInt32
# DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out -> Ptr{DOMAIN_CONTROLLER_INFOW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DsGetDcNameW(
    const uint16_t* ComputerName,
    const uint16_t* DomainName,
    void* DomainGuid,
    const uint16_t* SiteName,
    uint32_t Flags,
    void* DomainControllerInfo);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.DsGetDcNameW(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
-- ComputerName : LPCWSTR optional
-- DomainName : LPCWSTR optional
-- DomainGuid : GUID* optional
-- SiteName : LPCWSTR optional
-- Flags : DWORD
-- DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const DsGetDcNameW = lib.func('__stdcall', 'DsGetDcNameW', 'uint32_t', ['str16', 'str16', 'void *', 'str16', 'uint32_t', 'void *']);
// DsGetDcNameW(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
// ComputerName : LPCWSTR optional -> 'str16'
// DomainName : LPCWSTR optional -> 'str16'
// DomainGuid : GUID* optional -> 'void *'
// SiteName : LPCWSTR optional -> 'str16'
// Flags : DWORD -> 'uint32_t'
// DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  DsGetDcNameW: { parameters: ["buffer", "buffer", "pointer", "buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.DsGetDcNameW(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
// ComputerName : LPCWSTR optional -> "buffer"
// DomainName : LPCWSTR optional -> "buffer"
// DomainGuid : GUID* optional -> "pointer"
// SiteName : LPCWSTR optional -> "buffer"
// Flags : DWORD -> "u32"
// DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DsGetDcNameW(
    const uint16_t* ComputerName,
    const uint16_t* DomainName,
    void* DomainGuid,
    const uint16_t* SiteName,
    uint32_t Flags,
    void* DomainControllerInfo);
C, "NETAPI32.dll");
// $ffi->DsGetDcNameW(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo);
// ComputerName : LPCWSTR optional
// DomainName : LPCWSTR optional
// DomainGuid : GUID* optional
// SiteName : LPCWSTR optional
// Flags : DWORD
// DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Netapi32 extends StdCallLibrary {
    Netapi32 INSTANCE = Native.load("netapi32", Netapi32.class, W32APIOptions.UNICODE_OPTIONS);
    int DsGetDcNameW(
        WString ComputerName,   // LPCWSTR optional
        WString DomainName,   // LPCWSTR optional
        Pointer DomainGuid,   // GUID* optional
        WString SiteName,   // LPCWSTR optional
        int Flags,   // DWORD
        Pointer DomainControllerInfo   // DOMAIN_CONTROLLER_INFOW** out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("netapi32")]
lib LibNETAPI32
  fun DsGetDcNameW = DsGetDcNameW(
    ComputerName : UInt16*,   # LPCWSTR optional
    DomainName : UInt16*,   # LPCWSTR optional
    DomainGuid : GUID*,   # GUID* optional
    SiteName : UInt16*,   # LPCWSTR optional
    Flags : UInt32,   # DWORD
    DomainControllerInfo : DOMAIN_CONTROLLER_INFOW**   # DOMAIN_CONTROLLER_INFOW** out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DsGetDcNameWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Pointer<Utf16>, Uint32, Pointer<Void>);
typedef DsGetDcNameWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Pointer<Utf16>, int, Pointer<Void>);
final DsGetDcNameW = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<DsGetDcNameWNative, DsGetDcNameWDart>('DsGetDcNameW');
// ComputerName : LPCWSTR optional -> Pointer<Utf16>
// DomainName : LPCWSTR optional -> Pointer<Utf16>
// DomainGuid : GUID* optional -> Pointer<Void>
// SiteName : LPCWSTR optional -> Pointer<Utf16>
// Flags : DWORD -> Uint32
// DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsGetDcNameW(
  ComputerName: PWideChar;   // LPCWSTR optional
  DomainName: PWideChar;   // LPCWSTR optional
  DomainGuid: PGUID;   // GUID* optional
  SiteName: PWideChar;   // LPCWSTR optional
  Flags: DWORD;   // DWORD
  DomainControllerInfo: Pointer   // DOMAIN_CONTROLLER_INFOW** out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'DsGetDcNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsGetDcNameW"
  c_DsGetDcNameW :: CWString -> CWString -> Ptr () -> CWString -> Word32 -> Ptr () -> IO Word32
-- ComputerName : LPCWSTR optional -> CWString
-- DomainName : LPCWSTR optional -> CWString
-- DomainGuid : GUID* optional -> Ptr ()
-- SiteName : LPCWSTR optional -> CWString
-- Flags : DWORD -> Word32
-- DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsgetdcnamew =
  foreign "DsGetDcNameW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> (ptr uint16_t) @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* ComputerName : LPCWSTR optional -> (ptr uint16_t) *)
(* DomainName : LPCWSTR optional -> (ptr uint16_t) *)
(* DomainGuid : GUID* optional -> (ptr void) *)
(* SiteName : LPCWSTR optional -> (ptr uint16_t) *)
(* Flags : DWORD -> uint32_t *)
(* DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("DsGetDcNameW" ds-get-dc-name-w :convention :stdcall) :uint32
  (computer-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (domain-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (domain-guid :pointer)   ; GUID* optional
  (site-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (flags :uint32)   ; DWORD
  (domain-controller-info :pointer))   ; DOMAIN_CONTROLLER_INFOW** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsGetDcNameW = Win32::API::More->new('NETAPI32',
    'DWORD DsGetDcNameW(LPCWSTR ComputerName, LPCWSTR DomainName, LPVOID DomainGuid, LPCWSTR SiteName, DWORD Flags, LPVOID DomainControllerInfo)');
# my $ret = $DsGetDcNameW->Call($ComputerName, $DomainName, $DomainGuid, $SiteName, $Flags, $DomainControllerInfo);
# ComputerName : LPCWSTR optional -> LPCWSTR
# DomainName : LPCWSTR optional -> LPCWSTR
# DomainGuid : GUID* optional -> LPVOID
# SiteName : LPCWSTR optional -> LPCWSTR
# Flags : DWORD -> DWORD
# DomainControllerInfo : DOMAIN_CONTROLLER_INFOW** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型