ホーム › NetworkManagement.Dhcp › DhcpEnumClasses

DhcpEnumClasses

関数

DHCPサーバーに定義されたクラスの一覧を列挙する。

DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD DhcpEnumClasses(
    LPWSTR ServerIpAddress,   // optional
    DWORD ReservedMustBeZero,
    DWORD* ResumeHandle,
    DWORD PreferredMaximum,
    DHCP_CLASS_INFO_ARRAY** ClassInfoArray,
    DWORD* nRead,
    DWORD* nTotal
);

パラメーター

名前	型	方向	説明
ServerIpAddress	LPWSTR	inoptional	操作対象DHCPサーバのIPアドレスまたはホスト名(Unicode)。
ReservedMustBeZero	DWORD	in	予約パラメータ。必ず0を指定する。
ResumeHandle	DWORD*	inout	列挙の再開位置を示すDWORDへのポインタ。初回は0を指す。
PreferredMaximum	DWORD	in	一度に取得するクラス数の上限をバイト数で指定する。
ClassInfoArray	DHCP_CLASS_INFO_ARRAY**	inout	列挙結果を受け取るDHCP_CLASS_INFO_ARRAYへのポインタ。
nRead	DWORD*	inout	今回読み取ったクラス数を受け取るDWORDへのポインタ。
nTotal	DWORD*	inout	未列挙分も含む残りクラス総数を受け取るDWORDへのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpEnumClasses(
    LPWSTR ServerIpAddress,   // optional
    DWORD ReservedMustBeZero,
    DWORD* ResumeHandle,
    DWORD PreferredMaximum,
    DHCP_CLASS_INFO_ARRAY** ClassInfoArray,
    DWORD* nRead,
    DWORD* nTotal
);

[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpEnumClasses(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPWSTR optional
    uint ReservedMustBeZero,   // DWORD
    ref uint ResumeHandle,   // DWORD* in/out
    uint PreferredMaximum,   // DWORD
    IntPtr ClassInfoArray,   // DHCP_CLASS_INFO_ARRAY** in/out
    ref uint nRead,   // DWORD* in/out
    ref uint nTotal   // DWORD* in/out
);

<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpEnumClasses(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPWSTR optional
    ReservedMustBeZero As UInteger,   ' DWORD
    ByRef ResumeHandle As UInteger,   ' DWORD* in/out
    PreferredMaximum As UInteger,   ' DWORD
    ClassInfoArray As IntPtr,   ' DHCP_CLASS_INFO_ARRAY** in/out
    ByRef nRead As UInteger,   ' DWORD* in/out
    ByRef nTotal As UInteger   ' DWORD* in/out
) As UInteger
End Function

' ServerIpAddress : LPWSTR optional
' ReservedMustBeZero : DWORD
' ResumeHandle : DWORD* in/out
' PreferredMaximum : DWORD
' ClassInfoArray : DHCP_CLASS_INFO_ARRAY** in/out
' nRead : DWORD* in/out
' nTotal : DWORD* in/out
Declare PtrSafe Function DhcpEnumClasses Lib "dhcpsapi" ( _
    ByVal ServerIpAddress As LongPtr, _
    ByVal ReservedMustBeZero As Long, _
    ByRef ResumeHandle As Long, _
    ByVal PreferredMaximum As Long, _
    ByVal ClassInfoArray As LongPtr, _
    ByRef nRead As Long, _
    ByRef nTotal As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DhcpEnumClasses = ctypes.windll.dhcpsapi.DhcpEnumClasses
DhcpEnumClasses.restype = wintypes.DWORD
DhcpEnumClasses.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPWSTR optional
    wintypes.DWORD,  # ReservedMustBeZero : DWORD
    ctypes.POINTER(wintypes.DWORD),  # ResumeHandle : DWORD* in/out
    wintypes.DWORD,  # PreferredMaximum : DWORD
    ctypes.c_void_p,  # ClassInfoArray : DHCP_CLASS_INFO_ARRAY** in/out
    ctypes.POINTER(wintypes.DWORD),  # nRead : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # nTotal : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpEnumClasses = Fiddle::Function.new(
  lib['DhcpEnumClasses'],
  [
    Fiddle::TYPE_VOIDP,  # ServerIpAddress : LPWSTR optional
    -Fiddle::TYPE_INT,  # ReservedMustBeZero : DWORD
    Fiddle::TYPE_VOIDP,  # ResumeHandle : DWORD* in/out
    -Fiddle::TYPE_INT,  # PreferredMaximum : DWORD
    Fiddle::TYPE_VOIDP,  # ClassInfoArray : DHCP_CLASS_INFO_ARRAY** in/out
    Fiddle::TYPE_VOIDP,  # nRead : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # nTotal : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpEnumClasses(
        ServerIpAddress: *mut u16,  // LPWSTR optional
        ReservedMustBeZero: u32,  // DWORD
        ResumeHandle: *mut u32,  // DWORD* in/out
        PreferredMaximum: u32,  // DWORD
        ClassInfoArray: *mut *mut DHCP_CLASS_INFO_ARRAY,  // DHCP_CLASS_INFO_ARRAY** in/out
        nRead: *mut u32,  // DWORD* in/out
        nTotal: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpEnumClasses([MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress, uint ReservedMustBeZero, ref uint ResumeHandle, uint PreferredMaximum, IntPtr ClassInfoArray, ref uint nRead, ref uint nTotal);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpEnumClasses' -Namespace Win32 -PassThru
# $api::DhcpEnumClasses(ServerIpAddress, ReservedMustBeZero, ResumeHandle, PreferredMaximum, ClassInfoArray, nRead, nTotal)

#uselib "DHCPSAPI.dll"
#func global DhcpEnumClasses "DhcpEnumClasses" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DhcpEnumClasses ServerIpAddress, ReservedMustBeZero, varptr(ResumeHandle), PreferredMaximum, varptr(ClassInfoArray), varptr(nRead), varptr(nTotal)   ; 戻り値は stat
; ServerIpAddress : LPWSTR optional -> "sptr"
; ReservedMustBeZero : DWORD -> "sptr"
; ResumeHandle : DWORD* in/out -> "sptr"
; PreferredMaximum : DWORD -> "sptr"
; ClassInfoArray : DHCP_CLASS_INFO_ARRAY** in/out -> "sptr"
; nRead : DWORD* in/out -> "sptr"
; nTotal : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "DHCPSAPI.dll"
#cfunc global DhcpEnumClasses "DhcpEnumClasses" wstr, int, var, int, var, var, var
; res = DhcpEnumClasses(ServerIpAddress, ReservedMustBeZero, ResumeHandle, PreferredMaximum, ClassInfoArray, nRead, nTotal)
; ServerIpAddress : LPWSTR optional -> "wstr"
; ReservedMustBeZero : DWORD -> "int"
; ResumeHandle : DWORD* in/out -> "var"
; PreferredMaximum : DWORD -> "int"
; ClassInfoArray : DHCP_CLASS_INFO_ARRAY** in/out -> "var"
; nRead : DWORD* in/out -> "var"
; nTotal : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "DHCPSAPI.dll"
#cfunc global DhcpEnumClasses "DhcpEnumClasses" wstr, int, sptr, int, sptr, sptr, sptr
; res = DhcpEnumClasses(ServerIpAddress, ReservedMustBeZero, varptr(ResumeHandle), PreferredMaximum, varptr(ClassInfoArray), varptr(nRead), varptr(nTotal))
; ServerIpAddress : LPWSTR optional -> "wstr"
; ReservedMustBeZero : DWORD -> "int"
; ResumeHandle : DWORD* in/out -> "sptr"
; PreferredMaximum : DWORD -> "int"
; ClassInfoArray : DHCP_CLASS_INFO_ARRAY** in/out -> "sptr"
; nRead : DWORD* in/out -> "sptr"
; nTotal : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD DhcpEnumClasses(LPWSTR ServerIpAddress, DWORD ReservedMustBeZero, DWORD* ResumeHandle, DWORD PreferredMaximum, DHCP_CLASS_INFO_ARRAY** ClassInfoArray, DWORD* nRead, DWORD* nTotal)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpEnumClasses "DhcpEnumClasses" wstr, int, var, int, var, var, var
; res = DhcpEnumClasses(ServerIpAddress, ReservedMustBeZero, ResumeHandle, PreferredMaximum, ClassInfoArray, nRead, nTotal)
; ServerIpAddress : LPWSTR optional -> "wstr"
; ReservedMustBeZero : DWORD -> "int"
; ResumeHandle : DWORD* in/out -> "var"
; PreferredMaximum : DWORD -> "int"
; ClassInfoArray : DHCP_CLASS_INFO_ARRAY** in/out -> "var"
; nRead : DWORD* in/out -> "var"
; nTotal : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD DhcpEnumClasses(LPWSTR ServerIpAddress, DWORD ReservedMustBeZero, DWORD* ResumeHandle, DWORD PreferredMaximum, DHCP_CLASS_INFO_ARRAY** ClassInfoArray, DWORD* nRead, DWORD* nTotal)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpEnumClasses "DhcpEnumClasses" wstr, int, intptr, int, intptr, intptr, intptr
; res = DhcpEnumClasses(ServerIpAddress, ReservedMustBeZero, varptr(ResumeHandle), PreferredMaximum, varptr(ClassInfoArray), varptr(nRead), varptr(nTotal))
; ServerIpAddress : LPWSTR optional -> "wstr"
; ReservedMustBeZero : DWORD -> "int"
; ResumeHandle : DWORD* in/out -> "intptr"
; PreferredMaximum : DWORD -> "int"
; ClassInfoArray : DHCP_CLASS_INFO_ARRAY** in/out -> "intptr"
; nRead : DWORD* in/out -> "intptr"
; nTotal : DWORD* in/out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpEnumClasses = dhcpsapi.NewProc("DhcpEnumClasses")
)

// ServerIpAddress (LPWSTR optional), ReservedMustBeZero (DWORD), ResumeHandle (DWORD* in/out), PreferredMaximum (DWORD), ClassInfoArray (DHCP_CLASS_INFO_ARRAY** in/out), nRead (DWORD* in/out), nTotal (DWORD* in/out)
r1, _, err := procDhcpEnumClasses.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ServerIpAddress))),
	uintptr(ReservedMustBeZero),
	uintptr(ResumeHandle),
	uintptr(PreferredMaximum),
	uintptr(ClassInfoArray),
	uintptr(nRead),
	uintptr(nTotal),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function DhcpEnumClasses(
  ServerIpAddress: PWideChar;   // LPWSTR optional
  ReservedMustBeZero: DWORD;   // DWORD
  ResumeHandle: Pointer;   // DWORD* in/out
  PreferredMaximum: DWORD;   // DWORD
  ClassInfoArray: Pointer;   // DHCP_CLASS_INFO_ARRAY** in/out
  nRead: Pointer;   // DWORD* in/out
  nTotal: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpEnumClasses';

result := DllCall("DHCPSAPI\DhcpEnumClasses"
    , "WStr", ServerIpAddress   ; LPWSTR optional
    , "UInt", ReservedMustBeZero   ; DWORD
    , "Ptr", ResumeHandle   ; DWORD* in/out
    , "UInt", PreferredMaximum   ; DWORD
    , "Ptr", ClassInfoArray   ; DHCP_CLASS_INFO_ARRAY** in/out
    , "Ptr", nRead   ; DWORD* in/out
    , "Ptr", nTotal   ; DWORD* in/out
    , "UInt")   ; return: DWORD

●DhcpEnumClasses(ServerIpAddress, ReservedMustBeZero, ResumeHandle, PreferredMaximum, ClassInfoArray, nRead, nTotal) = DLL("DHCPSAPI.dll", "dword DhcpEnumClasses(char*, dword, void*, dword, void*, void*, void*)")
# 呼び出し: DhcpEnumClasses(ServerIpAddress, ReservedMustBeZero, ResumeHandle, PreferredMaximum, ClassInfoArray, nRead, nTotal)
# ServerIpAddress : LPWSTR optional -> "char*"
# ReservedMustBeZero : DWORD -> "dword"
# ResumeHandle : DWORD* in/out -> "void*"
# PreferredMaximum : DWORD -> "dword"
# ClassInfoArray : DHCP_CLASS_INFO_ARRAY** in/out -> "void*"
# nRead : DWORD* in/out -> "void*"
# nTotal : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。