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

DsListServersInSiteA

関数
指定サイト内のサーバー(DC)の一覧を取得する。
DLLNTDSAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// NTDSAPI.dll  (ANSI / -A)
#include <windows.h>

DWORD DsListServersInSiteA(
    HANDLE hDs,
    LPCSTR site,
    DS_NAME_RESULTA** ppServers
);

パラメーター

名前型方向説明
hDsHANDLEin操作に用いるディレクトリサービスバインドハンドル。
siteLPCSTRinサーバ一覧を取得する対象サイトのDN(ANSI)。
ppServersDS_NAME_RESULTA**outサーバ一覧をDS_NAME_RESULTAで受け取るポインタのアドレス。DsFreeNameResultAで解放する。

戻り値の型: DWORD

各言語での呼び出し定義

// NTDSAPI.dll  (ANSI / -A)
#include <windows.h>

DWORD DsListServersInSiteA(
    HANDLE hDs,
    LPCSTR site,
    DS_NAME_RESULTA** ppServers
);
[DllImport("NTDSAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint DsListServersInSiteA(
    IntPtr hDs,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string site,   // LPCSTR
    IntPtr ppServers   // DS_NAME_RESULTA** out
);
<DllImport("NTDSAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DsListServersInSiteA(
    hDs As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> site As String,   ' LPCSTR
    ppServers As IntPtr   ' DS_NAME_RESULTA** out
) As UInteger
End Function
' hDs : HANDLE
' site : LPCSTR
' ppServers : DS_NAME_RESULTA** out
Declare PtrSafe Function DsListServersInSiteA Lib "ntdsapi" ( _
    ByVal hDs As LongPtr, _
    ByVal site As String, _
    ByVal ppServers As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DsListServersInSiteA = ctypes.windll.ntdsapi.DsListServersInSiteA
DsListServersInSiteA.restype = wintypes.DWORD
DsListServersInSiteA.argtypes = [
    wintypes.HANDLE,  # hDs : HANDLE
    wintypes.LPCSTR,  # site : LPCSTR
    ctypes.c_void_p,  # ppServers : DS_NAME_RESULTA** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsListServersInSiteA = ntdsapi.NewProc("DsListServersInSiteA")
)

// hDs (HANDLE), site (LPCSTR), ppServers (DS_NAME_RESULTA** out)
r1, _, err := procDsListServersInSiteA.Call(
	uintptr(hDs),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(site))),
	uintptr(ppServers),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DsListServersInSiteA(
  hDs: THandle;   // HANDLE
  site: PAnsiChar;   // LPCSTR
  ppServers: Pointer   // DS_NAME_RESULTA** out
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsListServersInSiteA';
result := DllCall("NTDSAPI\DsListServersInSiteA"
    , "Ptr", hDs   ; HANDLE
    , "AStr", site   ; LPCSTR
    , "Ptr", ppServers   ; DS_NAME_RESULTA** out
    , "UInt")   ; return: DWORD
●DsListServersInSiteA(hDs, site, ppServers) = DLL("NTDSAPI.dll", "dword DsListServersInSiteA(void*, char*, void*)")
# 呼び出し: DsListServersInSiteA(hDs, site, ppServers)
# hDs : HANDLE -> "void*"
# site : LPCSTR -> "char*"
# ppServers : DS_NAME_RESULTA** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ntdsapi" fn DsListServersInSiteA(
    hDs: ?*anyopaque, // HANDLE
    site: [*c]const u8, // LPCSTR
    ppServers: [*c][*c]DS_NAME_RESULTA // DS_NAME_RESULTA** out
) callconv(std.os.windows.WINAPI) u32;
proc DsListServersInSiteA(
    hDs: pointer,  # HANDLE
    site: cstring,  # LPCSTR
    ppServers: ptr DS_NAME_RESULTA  # DS_NAME_RESULTA** out
): uint32 {.importc: "DsListServersInSiteA", stdcall, dynlib: "NTDSAPI.dll".}
pragma(lib, "ntdsapi");
extern(Windows)
uint DsListServersInSiteA(
    void* hDs,   // HANDLE
    const(char)* site,   // LPCSTR
    DS_NAME_RESULTA** ppServers   // DS_NAME_RESULTA** out
);
ccall((:DsListServersInSiteA, "NTDSAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cstring, Ptr{DS_NAME_RESULTA}),
      hDs, site, ppServers)
# hDs : HANDLE -> Ptr{Cvoid}
# site : LPCSTR -> Cstring
# ppServers : DS_NAME_RESULTA** out -> Ptr{DS_NAME_RESULTA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DsListServersInSiteA(
    void* hDs,
    const char* site,
    void* ppServers);
]]
local ntdsapi = ffi.load("ntdsapi")
-- ntdsapi.DsListServersInSiteA(hDs, site, ppServers)
-- hDs : HANDLE
-- site : LPCSTR
-- ppServers : DS_NAME_RESULTA** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NTDSAPI.dll');
const DsListServersInSiteA = lib.func('__stdcall', 'DsListServersInSiteA', 'uint32_t', ['void *', 'str', 'void *']);
// DsListServersInSiteA(hDs, site, ppServers)
// hDs : HANDLE -> 'void *'
// site : LPCSTR -> 'str'
// ppServers : DS_NAME_RESULTA** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NTDSAPI.dll", {
  DsListServersInSiteA: { parameters: ["pointer", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.DsListServersInSiteA(hDs, site, ppServers)
// hDs : HANDLE -> "pointer"
// site : LPCSTR -> "buffer"
// ppServers : DS_NAME_RESULTA** out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DsListServersInSiteA(
    void* hDs,
    const char* site,
    void* ppServers);
C, "NTDSAPI.dll");
// $ffi->DsListServersInSiteA(hDs, site, ppServers);
// hDs : HANDLE
// site : LPCSTR
// ppServers : DS_NAME_RESULTA** 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.ASCII_OPTIONS);
    int DsListServersInSiteA(
        Pointer hDs,   // HANDLE
        String site,   // LPCSTR
        Pointer ppServers   // DS_NAME_RESULTA** out
    );
}
@[Link("ntdsapi")]
lib LibNTDSAPI
  fun DsListServersInSiteA = DsListServersInSiteA(
    hDs : Void*,   # HANDLE
    site : UInt8*,   # LPCSTR
    ppServers : DS_NAME_RESULTA**   # DS_NAME_RESULTA** out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

let dslistserversinsitea =
  foreign "DsListServersInSiteA"
    ((ptr void) @-> string @-> (ptr void) @-> returning uint32_t)
(* hDs : HANDLE -> (ptr void) *)
(* site : LPCSTR -> string *)
(* ppServers : DS_NAME_RESULTA** 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 ("DsListServersInSiteA" ds-list-servers-in-site-a :convention :stdcall) :uint32
  (h-ds :pointer)   ; HANDLE
  (site :string)   ; LPCSTR
  (pp-servers :pointer))   ; DS_NAME_RESULTA** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsListServersInSiteA = Win32::API::More->new('NTDSAPI',
    'DWORD DsListServersInSiteA(HANDLE hDs, LPCSTR site, LPVOID ppServers)');
# my $ret = $DsListServersInSiteA->Call($hDs, $site, $ppServers);
# hDs : HANDLE -> HANDLE
# site : LPCSTR -> LPCSTR
# ppServers : DS_NAME_RESULTA** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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