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

DsListInfoForServerW

関数
指定サーバーに関するディレクトリ情報を取得する。
DLLNTDSAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD DsListInfoForServerW(
    HANDLE hDs,
    LPCWSTR server,
    DS_NAME_RESULTW** ppInfo
);

パラメーター

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

戻り値の型: DWORD

各言語での呼び出し定義

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

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

DsListInfoForServerW = ctypes.windll.ntdsapi.DsListInfoForServerW
DsListInfoForServerW.restype = wintypes.DWORD
DsListInfoForServerW.argtypes = [
    wintypes.HANDLE,  # hDs : HANDLE
    wintypes.LPCWSTR,  # server : LPCWSTR
    ctypes.c_void_p,  # ppInfo : DS_NAME_RESULTW** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsListInfoForServerW = ntdsapi.NewProc("DsListInfoForServerW")
)

// hDs (HANDLE), server (LPCWSTR), ppInfo (DS_NAME_RESULTW** out)
r1, _, err := procDsListInfoForServerW.Call(
	uintptr(hDs),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(server))),
	uintptr(ppInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DsListInfoForServerW(
  hDs: THandle;   // HANDLE
  server: PWideChar;   // LPCWSTR
  ppInfo: Pointer   // DS_NAME_RESULTW** out
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsListInfoForServerW';
result := DllCall("NTDSAPI\DsListInfoForServerW"
    , "Ptr", hDs   ; HANDLE
    , "WStr", server   ; LPCWSTR
    , "Ptr", ppInfo   ; DS_NAME_RESULTW** out
    , "UInt")   ; return: DWORD
●DsListInfoForServerW(hDs, server, ppInfo) = DLL("NTDSAPI.dll", "dword DsListInfoForServerW(void*, char*, void*)")
# 呼び出し: DsListInfoForServerW(hDs, server, ppInfo)
# hDs : HANDLE -> "void*"
# server : LPCWSTR -> "char*"
# ppInfo : 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 DsListInfoForServerW(
    hDs: ?*anyopaque, // HANDLE
    server: [*c]const u16, // LPCWSTR
    ppInfo: [*c][*c]DS_NAME_RESULTW // DS_NAME_RESULTW** out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc DsListInfoForServerW(
    hDs: pointer,  # HANDLE
    server: WideCString,  # LPCWSTR
    ppInfo: ptr DS_NAME_RESULTW  # DS_NAME_RESULTW** out
): uint32 {.importc: "DsListInfoForServerW", stdcall, dynlib: "NTDSAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "ntdsapi");
extern(Windows)
uint DsListInfoForServerW(
    void* hDs,   // HANDLE
    const(wchar)* server,   // LPCWSTR
    DS_NAME_RESULTW** ppInfo   // DS_NAME_RESULTW** out
);
ccall((:DsListInfoForServerW, "NTDSAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cwstring, Ptr{DS_NAME_RESULTW}),
      hDs, server, ppInfo)
# hDs : HANDLE -> Ptr{Cvoid}
# server : LPCWSTR -> Cwstring
# ppInfo : 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 DsListInfoForServerW(
    void* hDs,
    const uint16_t* server,
    void* ppInfo);
]]
local ntdsapi = ffi.load("ntdsapi")
-- ntdsapi.DsListInfoForServerW(hDs, server, ppInfo)
-- hDs : HANDLE
-- server : LPCWSTR
-- ppInfo : 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 DsListInfoForServerW = lib.func('__stdcall', 'DsListInfoForServerW', 'uint32_t', ['void *', 'str16', 'void *']);
// DsListInfoForServerW(hDs, server, ppInfo)
// hDs : HANDLE -> 'void *'
// server : LPCWSTR -> 'str16'
// ppInfo : DS_NAME_RESULTW** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NTDSAPI.dll", {
  DsListInfoForServerW: { parameters: ["pointer", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.DsListInfoForServerW(hDs, server, ppInfo)
// hDs : HANDLE -> "pointer"
// server : LPCWSTR -> "buffer"
// ppInfo : 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 DsListInfoForServerW(
    void* hDs,
    const uint16_t* server,
    void* ppInfo);
C, "NTDSAPI.dll");
// $ffi->DsListInfoForServerW(hDs, server, ppInfo);
// hDs : HANDLE
// server : LPCWSTR
// ppInfo : 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 DsListInfoForServerW(
        Pointer hDs,   // HANDLE
        WString server,   // LPCWSTR
        Pointer ppInfo   // DS_NAME_RESULTW** out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("ntdsapi")]
lib LibNTDSAPI
  fun DsListInfoForServerW = DsListInfoForServerW(
    hDs : Void*,   # HANDLE
    server : UInt16*,   # LPCWSTR
    ppInfo : 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 DsListInfoForServerWNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>);
typedef DsListInfoForServerWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>);
final DsListInfoForServerW = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsListInfoForServerWNative, DsListInfoForServerWDart>('DsListInfoForServerW');
// hDs : HANDLE -> Pointer<Void>
// server : LPCWSTR -> Pointer<Utf16>
// ppInfo : DS_NAME_RESULTW** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsListInfoForServerW(
  hDs: THandle;   // HANDLE
  server: PWideChar;   // LPCWSTR
  ppInfo: Pointer   // DS_NAME_RESULTW** out
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsListInfoForServerW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

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