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

DsListServersForDomainInSiteW

関数
指定サイト内の特定ドメインに属するサーバー一覧を取得する。
DLLNTDSAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD DsListServersForDomainInSiteW(
    HANDLE hDs,
    LPCWSTR domain,
    LPCWSTR site,
    DS_NAME_RESULTW** ppServers
);

パラメーター

名前方向説明
hDsHANDLEin操作に用いるディレクトリサービスバインドハンドル。
domainLPCWSTRin対象ドメインのDN(ワイド)。
siteLPCWSTRin対象サイトのDN(ワイド)。
ppServersDS_NAME_RESULTW**out該当サーバ一覧をDS_NAME_RESULTWで受け取るポインタのアドレス。DsFreeNameResultWで解放する。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

DsListServersForDomainInSiteW = ctypes.windll.ntdsapi.DsListServersForDomainInSiteW
DsListServersForDomainInSiteW.restype = wintypes.DWORD
DsListServersForDomainInSiteW.argtypes = [
    wintypes.HANDLE,  # hDs : HANDLE
    wintypes.LPCWSTR,  # domain : LPCWSTR
    wintypes.LPCWSTR,  # site : LPCWSTR
    ctypes.c_void_p,  # ppServers : DS_NAME_RESULTW** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsListServersForDomainInSiteW = ntdsapi.NewProc("DsListServersForDomainInSiteW")
)

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

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

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

foreign import stdcall safe "DsListServersForDomainInSiteW"
  c_DsListServersForDomainInSiteW :: Ptr () -> CWString -> CWString -> Ptr () -> IO Word32
-- hDs : HANDLE -> Ptr ()
-- domain : LPCWSTR -> CWString
-- site : LPCWSTR -> CWString
-- ppServers : DS_NAME_RESULTW** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dslistserversfordomaininsitew =
  foreign "DsListServersForDomainInSiteW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> returning uint32_t)
(* hDs : HANDLE -> (ptr void) *)
(* domain : LPCWSTR -> (ptr uint16_t) *)
(* site : LPCWSTR -> (ptr uint16_t) *)
(* ppServers : DS_NAME_RESULTW** 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 ("DsListServersForDomainInSiteW" ds-list-servers-for-domain-in-site-w :convention :stdcall) :uint32
  (h-ds :pointer)   ; HANDLE
  (domain (:string :encoding :utf-16le))   ; LPCWSTR
  (site (:string :encoding :utf-16le))   ; LPCWSTR
  (pp-servers :pointer))   ; DS_NAME_RESULTW** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsListServersForDomainInSiteW = Win32::API::More->new('NTDSAPI',
    'DWORD DsListServersForDomainInSiteW(HANDLE hDs, LPCWSTR domain, LPCWSTR site, LPVOID ppServers)');
# my $ret = $DsListServersForDomainInSiteW->Call($hDs, $domain, $site, $ppServers);
# hDs : HANDLE -> HANDLE
# domain : LPCWSTR -> LPCWSTR
# site : LPCWSTR -> LPCWSTR
# ppServers : DS_NAME_RESULTW** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型