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

DsListInfoForServerA

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

シグネチャ

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

DWORD DsListInfoForServerA(
    HANDLE hDs,
    LPCSTR server,
    DS_NAME_RESULTA** ppInfo
);

パラメーター

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

戻り値の型: DWORD

各言語での呼び出し定義

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

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

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

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

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsListInfoForServerA = ntdsapi.NewProc("DsListInfoForServerA")
)

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

extern "ntdsapi" fn DsListInfoForServerA(
    hDs: ?*anyopaque, // HANDLE
    server: [*c]const u8, // LPCSTR
    ppInfo: [*c][*c]DS_NAME_RESULTA // DS_NAME_RESULTA** out
) callconv(std.os.windows.WINAPI) u32;
proc DsListInfoForServerA(
    hDs: pointer,  # HANDLE
    server: cstring,  # LPCSTR
    ppInfo: ptr DS_NAME_RESULTA  # DS_NAME_RESULTA** out
): uint32 {.importc: "DsListInfoForServerA", stdcall, dynlib: "NTDSAPI.dll".}
pragma(lib, "ntdsapi");
extern(Windows)
uint DsListInfoForServerA(
    void* hDs,   // HANDLE
    const(char)* server,   // LPCSTR
    DS_NAME_RESULTA** ppInfo   // DS_NAME_RESULTA** out
);
ccall((:DsListInfoForServerA, "NTDSAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cstring, Ptr{DS_NAME_RESULTA}),
      hDs, server, ppInfo)
# hDs : HANDLE -> Ptr{Cvoid}
# server : LPCSTR -> Cstring
# ppInfo : DS_NAME_RESULTA** out -> Ptr{DS_NAME_RESULTA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DsListInfoForServerA(
    void* hDs,
    const char* server,
    void* ppInfo);
]]
local ntdsapi = ffi.load("ntdsapi")
-- ntdsapi.DsListInfoForServerA(hDs, server, ppInfo)
-- hDs : HANDLE
-- server : LPCSTR
-- ppInfo : DS_NAME_RESULTA** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NTDSAPI.dll');
const DsListInfoForServerA = lib.func('__stdcall', 'DsListInfoForServerA', 'uint32_t', ['void *', 'str', 'void *']);
// DsListInfoForServerA(hDs, server, ppInfo)
// hDs : HANDLE -> 'void *'
// server : LPCSTR -> 'str'
// ppInfo : DS_NAME_RESULTA** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NTDSAPI.dll", {
  DsListInfoForServerA: { parameters: ["pointer", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.DsListInfoForServerA(hDs, server, ppInfo)
// hDs : HANDLE -> "pointer"
// server : LPCSTR -> "buffer"
// ppInfo : DS_NAME_RESULTA** out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DsListInfoForServerA(
    void* hDs,
    const char* server,
    void* ppInfo);
C, "NTDSAPI.dll");
// $ffi->DsListInfoForServerA(hDs, server, ppInfo);
// hDs : HANDLE
// server : LPCSTR
// ppInfo : 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 DsListInfoForServerA(
        Pointer hDs,   // HANDLE
        String server,   // LPCSTR
        Pointer ppInfo   // DS_NAME_RESULTA** out
    );
}
@[Link("ntdsapi")]
lib LibNTDSAPI
  fun DsListInfoForServerA = DsListInfoForServerA(
    hDs : Void*,   # HANDLE
    server : UInt8*,   # LPCSTR
    ppInfo : 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 DsListInfoForServerANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Void>);
typedef DsListInfoForServerADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Void>);
final DsListInfoForServerA = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsListInfoForServerANative, DsListInfoForServerADart>('DsListInfoForServerA');
// hDs : HANDLE -> Pointer<Void>
// server : LPCSTR -> Pointer<Utf8>
// ppInfo : DS_NAME_RESULTA** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsListInfoForServerA(
  hDs: THandle;   // HANDLE
  server: PAnsiChar;   // LPCSTR
  ppInfo: Pointer   // DS_NAME_RESULTA** out
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsListInfoForServerA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

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