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

DsGetDomainControllerInfoW

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

シグネチャ

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

DWORD DsGetDomainControllerInfoW(
    HANDLE hDs,
    LPCWSTR DomainName,
    DWORD InfoLevel,
    DWORD* pcOut,
    void** ppInfo
);

パラメーター

名前方向説明
hDsHANDLEin操作に用いるディレクトリサービスバインドハンドル。
DomainNameLPCWSTRinDC情報を取得する対象ドメイン名(ワイド)。
InfoLevelDWORDin取得する情報の詳細レベル(1〜3など)を指定する。
pcOutDWORD*out返されたDC情報エントリ数を受け取るDWORDへのポインタ。
ppInfovoid**outDC情報配列を受け取るポインタのアドレス。DsFreeDomainControllerInfoWで解放する。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DsGetDomainControllerInfoW(
    HANDLE hDs,
    LPCWSTR DomainName,
    DWORD InfoLevel,
    DWORD* pcOut,
    void** ppInfo
);
[DllImport("NTDSAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint DsGetDomainControllerInfoW(
    IntPtr hDs,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string DomainName,   // LPCWSTR
    uint InfoLevel,   // DWORD
    out uint pcOut,   // DWORD* out
    IntPtr ppInfo   // void** out
);
<DllImport("NTDSAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function DsGetDomainControllerInfoW(
    hDs As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> DomainName As String,   ' LPCWSTR
    InfoLevel As UInteger,   ' DWORD
    <Out> ByRef pcOut As UInteger,   ' DWORD* out
    ppInfo As IntPtr   ' void** out
) As UInteger
End Function
' hDs : HANDLE
' DomainName : LPCWSTR
' InfoLevel : DWORD
' pcOut : DWORD* out
' ppInfo : void** out
Declare PtrSafe Function DsGetDomainControllerInfoW Lib "ntdsapi" ( _
    ByVal hDs As LongPtr, _
    ByVal DomainName As LongPtr, _
    ByVal InfoLevel As Long, _
    ByRef pcOut As Long, _
    ByVal ppInfo 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

DsGetDomainControllerInfoW = ctypes.windll.ntdsapi.DsGetDomainControllerInfoW
DsGetDomainControllerInfoW.restype = wintypes.DWORD
DsGetDomainControllerInfoW.argtypes = [
    wintypes.HANDLE,  # hDs : HANDLE
    wintypes.LPCWSTR,  # DomainName : LPCWSTR
    wintypes.DWORD,  # InfoLevel : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcOut : DWORD* out
    ctypes.c_void_p,  # ppInfo : void** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsGetDomainControllerInfoW = ntdsapi.NewProc("DsGetDomainControllerInfoW")
)

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

extern "ntdsapi" fn DsGetDomainControllerInfoW(
    hDs: ?*anyopaque, // HANDLE
    DomainName: [*c]const u16, // LPCWSTR
    InfoLevel: u32, // DWORD
    pcOut: [*c]u32, // DWORD* out
    ppInfo: ?*anyopaque // void** out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc DsGetDomainControllerInfoW(
    hDs: pointer,  # HANDLE
    DomainName: WideCString,  # LPCWSTR
    InfoLevel: uint32,  # DWORD
    pcOut: ptr uint32,  # DWORD* out
    ppInfo: pointer  # void** out
): uint32 {.importc: "DsGetDomainControllerInfoW", stdcall, dynlib: "NTDSAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "ntdsapi");
extern(Windows)
uint DsGetDomainControllerInfoW(
    void* hDs,   // HANDLE
    const(wchar)* DomainName,   // LPCWSTR
    uint InfoLevel,   // DWORD
    uint* pcOut,   // DWORD* out
    void** ppInfo   // void** out
);
ccall((:DsGetDomainControllerInfoW, "NTDSAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cwstring, UInt32, Ptr{UInt32}, Ptr{Cvoid}),
      hDs, DomainName, InfoLevel, pcOut, ppInfo)
# hDs : HANDLE -> Ptr{Cvoid}
# DomainName : LPCWSTR -> Cwstring
# InfoLevel : DWORD -> UInt32
# pcOut : DWORD* out -> Ptr{UInt32}
# ppInfo : void** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DsGetDomainControllerInfoW(
    void* hDs,
    const uint16_t* DomainName,
    uint32_t InfoLevel,
    uint32_t* pcOut,
    void** ppInfo);
]]
local ntdsapi = ffi.load("ntdsapi")
-- ntdsapi.DsGetDomainControllerInfoW(hDs, DomainName, InfoLevel, pcOut, ppInfo)
-- hDs : HANDLE
-- DomainName : LPCWSTR
-- InfoLevel : DWORD
-- pcOut : DWORD* out
-- ppInfo : void** 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('NTDSAPI.dll');
const DsGetDomainControllerInfoW = lib.func('__stdcall', 'DsGetDomainControllerInfoW', 'uint32_t', ['void *', 'str16', 'uint32_t', 'uint32_t *', 'void *']);
// DsGetDomainControllerInfoW(hDs, DomainName, InfoLevel, pcOut, ppInfo)
// hDs : HANDLE -> 'void *'
// DomainName : LPCWSTR -> 'str16'
// InfoLevel : DWORD -> 'uint32_t'
// pcOut : DWORD* out -> 'uint32_t *'
// ppInfo : void** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NTDSAPI.dll", {
  DsGetDomainControllerInfoW: { parameters: ["pointer", "buffer", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.DsGetDomainControllerInfoW(hDs, DomainName, InfoLevel, pcOut, ppInfo)
// hDs : HANDLE -> "pointer"
// DomainName : LPCWSTR -> "buffer"
// InfoLevel : DWORD -> "u32"
// pcOut : DWORD* out -> "pointer"
// ppInfo : void** out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DsGetDomainControllerInfoW(
    void* hDs,
    const uint16_t* DomainName,
    uint32_t InfoLevel,
    uint32_t* pcOut,
    void** ppInfo);
C, "NTDSAPI.dll");
// $ffi->DsGetDomainControllerInfoW(hDs, DomainName, InfoLevel, pcOut, ppInfo);
// hDs : HANDLE
// DomainName : LPCWSTR
// InfoLevel : DWORD
// pcOut : DWORD* out
// ppInfo : void** 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 Ntdsapi extends StdCallLibrary {
    Ntdsapi INSTANCE = Native.load("ntdsapi", Ntdsapi.class, W32APIOptions.UNICODE_OPTIONS);
    int DsGetDomainControllerInfoW(
        Pointer hDs,   // HANDLE
        WString DomainName,   // LPCWSTR
        int InfoLevel,   // DWORD
        IntByReference pcOut,   // DWORD* out
        Pointer ppInfo   // void** out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("ntdsapi")]
lib LibNTDSAPI
  fun DsGetDomainControllerInfoW = DsGetDomainControllerInfoW(
    hDs : Void*,   # HANDLE
    DomainName : UInt16*,   # LPCWSTR
    InfoLevel : UInt32,   # DWORD
    pcOut : UInt32*,   # DWORD* out
    ppInfo : Void**   # void** out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DsGetDomainControllerInfoWNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, Pointer<Uint32>, Pointer<Void>);
typedef DsGetDomainControllerInfoWDart = int Function(Pointer<Void>, Pointer<Utf16>, int, Pointer<Uint32>, Pointer<Void>);
final DsGetDomainControllerInfoW = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsGetDomainControllerInfoWNative, DsGetDomainControllerInfoWDart>('DsGetDomainControllerInfoW');
// hDs : HANDLE -> Pointer<Void>
// DomainName : LPCWSTR -> Pointer<Utf16>
// InfoLevel : DWORD -> Uint32
// pcOut : DWORD* out -> Pointer<Uint32>
// ppInfo : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsGetDomainControllerInfoW(
  hDs: THandle;   // HANDLE
  DomainName: PWideChar;   // LPCWSTR
  InfoLevel: DWORD;   // DWORD
  pcOut: Pointer;   // DWORD* out
  ppInfo: Pointer   // void** out
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsGetDomainControllerInfoW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsGetDomainControllerInfoW"
  c_DsGetDomainControllerInfoW :: Ptr () -> CWString -> Word32 -> Ptr Word32 -> Ptr () -> IO Word32
-- hDs : HANDLE -> Ptr ()
-- DomainName : LPCWSTR -> CWString
-- InfoLevel : DWORD -> Word32
-- pcOut : DWORD* out -> Ptr Word32
-- ppInfo : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsgetdomaincontrollerinfow =
  foreign "DsGetDomainControllerInfoW"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr void) @-> returning uint32_t)
(* hDs : HANDLE -> (ptr void) *)
(* DomainName : LPCWSTR -> (ptr uint16_t) *)
(* InfoLevel : DWORD -> uint32_t *)
(* pcOut : DWORD* out -> (ptr uint32_t) *)
(* ppInfo : void** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ntdsapi (t "NTDSAPI.dll"))
(cffi:use-foreign-library ntdsapi)

(cffi:defcfun ("DsGetDomainControllerInfoW" ds-get-domain-controller-info-w :convention :stdcall) :uint32
  (h-ds :pointer)   ; HANDLE
  (domain-name (:string :encoding :utf-16le))   ; LPCWSTR
  (info-level :uint32)   ; DWORD
  (pc-out :pointer)   ; DWORD* out
  (pp-info :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsGetDomainControllerInfoW = Win32::API::More->new('NTDSAPI',
    'DWORD DsGetDomainControllerInfoW(HANDLE hDs, LPCWSTR DomainName, DWORD InfoLevel, LPVOID pcOut, LPVOID ppInfo)');
# my $ret = $DsGetDomainControllerInfoW->Call($hDs, $DomainName, $InfoLevel, $pcOut, $ppInfo);
# hDs : HANDLE -> HANDLE
# DomainName : LPCWSTR -> LPCWSTR
# InfoLevel : DWORD -> DWORD
# pcOut : DWORD* out -> LPVOID
# ppInfo : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い