Win32 API 日本語リファレンス
ホームNetworkManagement.Dhcp › DhcpEnumServers

DhcpEnumServers

関数
ディレクトリに登録されたDHCPサーバーの一覧を列挙する。
DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

// DHCPSAPI.dll
#include <windows.h>

DWORD DhcpEnumServers(
    DWORD Flags,
    void* IdInfo,
    DHCPDS_SERVERS** Servers,
    void* CallbackFn,
    void* CallbackData
);

パラメーター

名前方向説明
FlagsDWORDin列挙動作を制御するフラグ。Active Directory検索の指定等に使う。
IdInfovoid*inoutディレクトリ検索の識別情報を指すポインタ。NULL可。
ServersDHCPDS_SERVERS**inout列挙されたDHCPサーバ一覧を受け取るDHCPDS_SERVERSへのポインタ。
CallbackFnvoid*inout各サーバ処理時に呼ばれるコールバック関数へのポインタ。NULL可。
CallbackDatavoid*inoutコールバック関数に渡すユーザ定義データへのポインタ。NULL可。

戻り値の型: DWORD

各言語での呼び出し定義

// DHCPSAPI.dll
#include <windows.h>

DWORD DhcpEnumServers(
    DWORD Flags,
    void* IdInfo,
    DHCPDS_SERVERS** Servers,
    void* CallbackFn,
    void* CallbackData
);
[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpEnumServers(
    uint Flags,   // DWORD
    IntPtr IdInfo,   // void* in/out
    IntPtr Servers,   // DHCPDS_SERVERS** in/out
    IntPtr CallbackFn,   // void* in/out
    IntPtr CallbackData   // void* in/out
);
<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpEnumServers(
    Flags As UInteger,   ' DWORD
    IdInfo As IntPtr,   ' void* in/out
    Servers As IntPtr,   ' DHCPDS_SERVERS** in/out
    CallbackFn As IntPtr,   ' void* in/out
    CallbackData As IntPtr   ' void* in/out
) As UInteger
End Function
' Flags : DWORD
' IdInfo : void* in/out
' Servers : DHCPDS_SERVERS** in/out
' CallbackFn : void* in/out
' CallbackData : void* in/out
Declare PtrSafe Function DhcpEnumServers Lib "dhcpsapi" ( _
    ByVal Flags As Long, _
    ByVal IdInfo As LongPtr, _
    ByVal Servers As LongPtr, _
    ByVal CallbackFn As LongPtr, _
    ByVal CallbackData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DhcpEnumServers = ctypes.windll.dhcpsapi.DhcpEnumServers
DhcpEnumServers.restype = wintypes.DWORD
DhcpEnumServers.argtypes = [
    wintypes.DWORD,  # Flags : DWORD
    ctypes.POINTER(None),  # IdInfo : void* in/out
    ctypes.c_void_p,  # Servers : DHCPDS_SERVERS** in/out
    ctypes.POINTER(None),  # CallbackFn : void* in/out
    ctypes.POINTER(None),  # CallbackData : void* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpEnumServers = Fiddle::Function.new(
  lib['DhcpEnumServers'],
  [
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # IdInfo : void* in/out
    Fiddle::TYPE_VOIDP,  # Servers : DHCPDS_SERVERS** in/out
    Fiddle::TYPE_VOIDP,  # CallbackFn : void* in/out
    Fiddle::TYPE_VOIDP,  # CallbackData : void* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpEnumServers(
        Flags: u32,  // DWORD
        IdInfo: *mut (),  // void* in/out
        Servers: *mut *mut DHCPDS_SERVERS,  // DHCPDS_SERVERS** in/out
        CallbackFn: *mut (),  // void* in/out
        CallbackData: *mut ()  // void* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpEnumServers(uint Flags, IntPtr IdInfo, IntPtr Servers, IntPtr CallbackFn, IntPtr CallbackData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpEnumServers' -Namespace Win32 -PassThru
# $api::DhcpEnumServers(Flags, IdInfo, Servers, CallbackFn, CallbackData)
#uselib "DHCPSAPI.dll"
#func global DhcpEnumServers "DhcpEnumServers" sptr, sptr, sptr, sptr, sptr
; DhcpEnumServers Flags, IdInfo, varptr(Servers), CallbackFn, CallbackData   ; 戻り値は stat
; Flags : DWORD -> "sptr"
; IdInfo : void* in/out -> "sptr"
; Servers : DHCPDS_SERVERS** in/out -> "sptr"
; CallbackFn : void* in/out -> "sptr"
; CallbackData : void* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "DHCPSAPI.dll"
#cfunc global DhcpEnumServers "DhcpEnumServers" int, sptr, var, sptr, sptr
; res = DhcpEnumServers(Flags, IdInfo, Servers, CallbackFn, CallbackData)
; Flags : DWORD -> "int"
; IdInfo : void* in/out -> "sptr"
; Servers : DHCPDS_SERVERS** in/out -> "var"
; CallbackFn : void* in/out -> "sptr"
; CallbackData : void* in/out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD DhcpEnumServers(DWORD Flags, void* IdInfo, DHCPDS_SERVERS** Servers, void* CallbackFn, void* CallbackData)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpEnumServers "DhcpEnumServers" int, intptr, var, intptr, intptr
; res = DhcpEnumServers(Flags, IdInfo, Servers, CallbackFn, CallbackData)
; Flags : DWORD -> "int"
; IdInfo : void* in/out -> "intptr"
; Servers : DHCPDS_SERVERS** in/out -> "var"
; CallbackFn : void* in/out -> "intptr"
; CallbackData : void* in/out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpEnumServers = dhcpsapi.NewProc("DhcpEnumServers")
)

// Flags (DWORD), IdInfo (void* in/out), Servers (DHCPDS_SERVERS** in/out), CallbackFn (void* in/out), CallbackData (void* in/out)
r1, _, err := procDhcpEnumServers.Call(
	uintptr(Flags),
	uintptr(IdInfo),
	uintptr(Servers),
	uintptr(CallbackFn),
	uintptr(CallbackData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DhcpEnumServers(
  Flags: DWORD;   // DWORD
  IdInfo: Pointer;   // void* in/out
  Servers: Pointer;   // DHCPDS_SERVERS** in/out
  CallbackFn: Pointer;   // void* in/out
  CallbackData: Pointer   // void* in/out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpEnumServers';
result := DllCall("DHCPSAPI\DhcpEnumServers"
    , "UInt", Flags   ; DWORD
    , "Ptr", IdInfo   ; void* in/out
    , "Ptr", Servers   ; DHCPDS_SERVERS** in/out
    , "Ptr", CallbackFn   ; void* in/out
    , "Ptr", CallbackData   ; void* in/out
    , "UInt")   ; return: DWORD
●DhcpEnumServers(Flags, IdInfo, Servers, CallbackFn, CallbackData) = DLL("DHCPSAPI.dll", "dword DhcpEnumServers(dword, void*, void*, void*, void*)")
# 呼び出し: DhcpEnumServers(Flags, IdInfo, Servers, CallbackFn, CallbackData)
# Flags : DWORD -> "dword"
# IdInfo : void* in/out -> "void*"
# Servers : DHCPDS_SERVERS** in/out -> "void*"
# CallbackFn : void* in/out -> "void*"
# CallbackData : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。