ホーム › Security.Authentication.Identity › LsaEnumerateTrustedDomains

LsaEnumerateTrustedDomains

関数

ポリシーに登録された信頼ドメインの一覧を列挙する。

DLLADVAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll
#include <windows.h>

NTSTATUS LsaEnumerateTrustedDomains(
    LSA_HANDLE PolicyHandle,
    DWORD* EnumerationContext,
    void** Buffer,
    DWORD PreferedMaximumLength,
    DWORD* CountReturned
);

パラメーター

名前	型	方向	説明
PolicyHandle	LSA_HANDLE	in	Policy オブジェクトへのハンドル。このハンドルには POLICY_VIEW_LOCAL_INFORMATION アクセス権が必要です。詳細については、ポリシーオブジェクトハンドルを開くを参照してください。
EnumerationContext	DWORD*	inout	すべての信頼されたドメインを列挙するために複数回の呼び出しを行えるようにする列挙ハンドルへのポインター。LsaEnumerateTrustedDomains の最初の呼び出しでは、EnumerationContext はゼロに初期化された変数を指している必要があります。以降の LsaEnumerateTrustedDomains の呼び出しでは、EnumerationContext は前回の呼び出しで返された列挙ハンドルを指している必要があります。
Buffer	void**	out	1 つ以上の信頼されたドメインの名前と SID を含む LSA_TRUST_INFORMATION 構造体の配列へのポインターを受け取ります。この情報が不要になったら、返されたポインターを LsaFreeMemory に渡してください。
PreferedMaximumLength	DWORD	in	返されるバッファーの推奨最大サイズ (バイト単位) を指定します。この値は目安であり、実際に返されるバイト数はこの値より大きくなることがあります。
CountReturned	DWORD*	out	Buffer パラメーターで返される要素の数を受け取る変数へのポインター。

戻り値の型: NTSTATUS

公式ドキュメント

LsaEnumerateTrustedDomains 関数は、ログオン資格情報の認証を信頼されているドメインの名前と SID を取得します。

戻り値

関数が成功した場合、戻り値は次の NTSTATUS 値のいずれかです。

値	説明
STATUS_SUCCESS	列挙が正常に完了しました。
STATUS_MORE_ENTRIES	呼び出しは成功しましたが、列挙すべき信頼されたドメインがまだ残っています。EnumerationContext パラメーターで返された値を渡して、LsaEnumerateTrustedDomains を再度呼び出してください。
STATUS_NO_MORE_ENTRIES	列挙すべき信頼されたドメインはこれ以上ありません。

関数が失敗した場合、戻り値は NTSTATUS コードです。詳細については、 LSA ポリシー関数の戻り値を参照してください。

LsaNtStatusToWinError 関数を使用して、NTSTATUS コードを Windows エラーコードに変換できます。

解説(Remarks)

ドメインコントローラーが Windows NT 4.0 以前のバージョンの Windows NT のみで動作しているドメインでは、LsaEnumerateTrustedDomains はすべての信頼されたドメインの一覧を返します。Windows NT 4.0 までのリリースでは、すべての信頼されたドメインは直接信頼されています。

Windows XP および Windows 2000 の混在モードドメインでは、ドメインコントローラーは Windows XP、Windows 2000、または Windows NT で動作している可能性があります。そのため、混在モードドメインでは、直接信頼されているドメインと間接的に信頼されているドメインが混在します。混在モードドメイン内のシステムの信頼されたドメインを列挙する場合、LsaEnumerateTrustedDomains は直接信頼されているドメインのみを返します。

これに対し、Windows XP および Windows 2000 のネイティブモードドメインには Windows 2000 ドメインコントローラーのみが含まれます (ドメイン内に Windows NT 4.0 以前のバージョンを実行しているメンバーが存在する場合でも同様です)。ネイティブモードの Windows XP および Windows 2000 ドメイン内のシステムの信頼されたドメインを列挙する場合、LsaEnumerateTrustedDomains は直接信頼されているドメインと間接的に信頼されているドメインの両方を返します。

すべての信頼情報を取得するには、LsaEnumerateTrustedDomains を複数回呼び出す必要がある場合があります。EnumerationContext パラメーターを使用して、次のように複数回の呼び出しを行えます。最初の呼び出しでは、EnumerationContext が指す変数をゼロに設定します。LsaEnumerateTrustedDomains が STATUS_SUCCESS または STATUS_MORE_ENTRIES を返した場合は、前回の呼び出しで返された EnumerationContext の値を渡して関数を再度呼び出します。関数が STATUS_NO_MORE_ENTRIES を返した時点で列挙は完了です。

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

各言語での呼び出し定義

// ADVAPI32.dll
#include <windows.h>

NTSTATUS LsaEnumerateTrustedDomains(
    LSA_HANDLE PolicyHandle,
    DWORD* EnumerationContext,
    void** Buffer,
    DWORD PreferedMaximumLength,
    DWORD* CountReturned
);

[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern int LsaEnumerateTrustedDomains(
    IntPtr PolicyHandle,   // LSA_HANDLE
    ref uint EnumerationContext,   // DWORD* in/out
    IntPtr Buffer,   // void** out
    uint PreferedMaximumLength,   // DWORD
    out uint CountReturned   // DWORD* out
);

<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function LsaEnumerateTrustedDomains(
    PolicyHandle As IntPtr,   ' LSA_HANDLE
    ByRef EnumerationContext As UInteger,   ' DWORD* in/out
    Buffer As IntPtr,   ' void** out
    PreferedMaximumLength As UInteger,   ' DWORD
    <Out> ByRef CountReturned As UInteger   ' DWORD* out
) As Integer
End Function

' PolicyHandle : LSA_HANDLE
' EnumerationContext : DWORD* in/out
' Buffer : void** out
' PreferedMaximumLength : DWORD
' CountReturned : DWORD* out
Declare PtrSafe Function LsaEnumerateTrustedDomains Lib "advapi32" ( _
    ByVal PolicyHandle As LongPtr, _
    ByRef EnumerationContext As Long, _
    ByVal Buffer As LongPtr, _
    ByVal PreferedMaximumLength As Long, _
    ByRef CountReturned As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

LsaEnumerateTrustedDomains = ctypes.windll.advapi32.LsaEnumerateTrustedDomains
LsaEnumerateTrustedDomains.restype = ctypes.c_int
LsaEnumerateTrustedDomains.argtypes = [
    ctypes.c_ssize_t,  # PolicyHandle : LSA_HANDLE
    ctypes.POINTER(wintypes.DWORD),  # EnumerationContext : DWORD* in/out
    ctypes.c_void_p,  # Buffer : void** out
    wintypes.DWORD,  # PreferedMaximumLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # CountReturned : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
LsaEnumerateTrustedDomains = Fiddle::Function.new(
  lib['LsaEnumerateTrustedDomains'],
  [
    Fiddle::TYPE_INTPTR_T,  # PolicyHandle : LSA_HANDLE
    Fiddle::TYPE_VOIDP,  # EnumerationContext : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # Buffer : void** out
    -Fiddle::TYPE_INT,  # PreferedMaximumLength : DWORD
    Fiddle::TYPE_VOIDP,  # CountReturned : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn LsaEnumerateTrustedDomains(
        PolicyHandle: isize,  // LSA_HANDLE
        EnumerationContext: *mut u32,  // DWORD* in/out
        Buffer: *mut *mut (),  // void** out
        PreferedMaximumLength: u32,  // DWORD
        CountReturned: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll")]
public static extern int LsaEnumerateTrustedDomains(IntPtr PolicyHandle, ref uint EnumerationContext, IntPtr Buffer, uint PreferedMaximumLength, out uint CountReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_LsaEnumerateTrustedDomains' -Namespace Win32 -PassThru
# $api::LsaEnumerateTrustedDomains(PolicyHandle, EnumerationContext, Buffer, PreferedMaximumLength, CountReturned)

#uselib "ADVAPI32.dll"
#func global LsaEnumerateTrustedDomains "LsaEnumerateTrustedDomains" sptr, sptr, sptr, sptr, sptr
; LsaEnumerateTrustedDomains PolicyHandle, varptr(EnumerationContext), Buffer, PreferedMaximumLength, varptr(CountReturned)   ; 戻り値は stat
; PolicyHandle : LSA_HANDLE -> "sptr"
; EnumerationContext : DWORD* in/out -> "sptr"
; Buffer : void** out -> "sptr"
; PreferedMaximumLength : DWORD -> "sptr"
; CountReturned : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global LsaEnumerateTrustedDomains "LsaEnumerateTrustedDomains" sptr, var, sptr, int, var
; res = LsaEnumerateTrustedDomains(PolicyHandle, EnumerationContext, Buffer, PreferedMaximumLength, CountReturned)
; PolicyHandle : LSA_HANDLE -> "sptr"
; EnumerationContext : DWORD* in/out -> "var"
; Buffer : void** out -> "sptr"
; PreferedMaximumLength : DWORD -> "int"
; CountReturned : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global LsaEnumerateTrustedDomains "LsaEnumerateTrustedDomains" sptr, sptr, sptr, int, sptr
; res = LsaEnumerateTrustedDomains(PolicyHandle, varptr(EnumerationContext), Buffer, PreferedMaximumLength, varptr(CountReturned))
; PolicyHandle : LSA_HANDLE -> "sptr"
; EnumerationContext : DWORD* in/out -> "sptr"
; Buffer : void** out -> "sptr"
; PreferedMaximumLength : DWORD -> "int"
; CountReturned : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。