ホーム › NetworkManagement.Dhcp › DhcpV4EnumSubnetClients

DhcpV4EnumSubnetClients

関数

指定サブネット内のIPv4 DHCPクライアントを列挙する。

DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2012

シグネチャ

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

DWORD DhcpV4EnumSubnetClients(
    LPCWSTR ServerIpAddress,   // optional
    DWORD SubnetAddress,
    DWORD* ResumeHandle,
    DWORD PreferredMaximum,
    DHCP_CLIENT_INFO_PB_ARRAY** ClientInfo,
    DWORD* ClientsRead,
    DWORD* ClientsTotal
);

パラメーター

名前	型	方向	説明
ServerIpAddress	LPCWSTR	inoptional	対象DHCPサーバーのIPアドレスを示すUnicode文字列。ローカルならNULL可。
SubnetAddress	DWORD	in	クライアントを列挙する対象サブネットのIPアドレス(DWORD)。
ResumeHandle	DWORD*	inout	列挙の再開位置ハンドルへのポインタ。初回は0を指す変数を渡す。
PreferredMaximum	DWORD	in	1回で返すクライアントデータの推奨最大バイト数。
ClientInfo	DHCP_CLIENT_INFO_PB_ARRAY**	out	列挙結果のクライアント情報DHCP_CLIENT_INFO_PB_ARRAYへのポインタを受け取る二重ポインタ。使用後は解放する。
ClientsRead	DWORD*	out	今回読み取られたクライアント数を受け取るDWORDへのポインタ。
ClientsTotal	DWORD*	out	残りのクライアント総数を受け取るDWORDへのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpV4EnumSubnetClients(
    LPCWSTR ServerIpAddress,   // optional
    DWORD SubnetAddress,
    DWORD* ResumeHandle,
    DWORD PreferredMaximum,
    DHCP_CLIENT_INFO_PB_ARRAY** ClientInfo,
    DWORD* ClientsRead,
    DWORD* ClientsTotal
);

[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpV4EnumSubnetClients(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPCWSTR optional
    uint SubnetAddress,   // DWORD
    ref uint ResumeHandle,   // DWORD* in/out
    uint PreferredMaximum,   // DWORD
    IntPtr ClientInfo,   // DHCP_CLIENT_INFO_PB_ARRAY** out
    out uint ClientsRead,   // DWORD* out
    out uint ClientsTotal   // DWORD* out
);

<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpV4EnumSubnetClients(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPCWSTR optional
    SubnetAddress As UInteger,   ' DWORD
    ByRef ResumeHandle As UInteger,   ' DWORD* in/out
    PreferredMaximum As UInteger,   ' DWORD
    ClientInfo As IntPtr,   ' DHCP_CLIENT_INFO_PB_ARRAY** out
    <Out> ByRef ClientsRead As UInteger,   ' DWORD* out
    <Out> ByRef ClientsTotal As UInteger   ' DWORD* out
) As UInteger
End Function

' ServerIpAddress : LPCWSTR optional
' SubnetAddress : DWORD
' ResumeHandle : DWORD* in/out
' PreferredMaximum : DWORD
' ClientInfo : DHCP_CLIENT_INFO_PB_ARRAY** out
' ClientsRead : DWORD* out
' ClientsTotal : DWORD* out
Declare PtrSafe Function DhcpV4EnumSubnetClients Lib "dhcpsapi" ( _
    ByVal ServerIpAddress As LongPtr, _
    ByVal SubnetAddress As Long, _
    ByRef ResumeHandle As Long, _
    ByVal PreferredMaximum As Long, _
    ByVal ClientInfo As LongPtr, _
    ByRef ClientsRead As Long, _
    ByRef ClientsTotal As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DhcpV4EnumSubnetClients = ctypes.windll.dhcpsapi.DhcpV4EnumSubnetClients
DhcpV4EnumSubnetClients.restype = wintypes.DWORD
DhcpV4EnumSubnetClients.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPCWSTR optional
    wintypes.DWORD,  # SubnetAddress : DWORD
    ctypes.POINTER(wintypes.DWORD),  # ResumeHandle : DWORD* in/out
    wintypes.DWORD,  # PreferredMaximum : DWORD
    ctypes.c_void_p,  # ClientInfo : DHCP_CLIENT_INFO_PB_ARRAY** out
    ctypes.POINTER(wintypes.DWORD),  # ClientsRead : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # ClientsTotal : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpV4EnumSubnetClients = Fiddle::Function.new(
  lib['DhcpV4EnumSubnetClients'],
  [
    Fiddle::TYPE_VOIDP,  # ServerIpAddress : LPCWSTR optional
    -Fiddle::TYPE_INT,  # SubnetAddress : DWORD
    Fiddle::TYPE_VOIDP,  # ResumeHandle : DWORD* in/out
    -Fiddle::TYPE_INT,  # PreferredMaximum : DWORD
    Fiddle::TYPE_VOIDP,  # ClientInfo : DHCP_CLIENT_INFO_PB_ARRAY** out
    Fiddle::TYPE_VOIDP,  # ClientsRead : DWORD* out
    Fiddle::TYPE_VOIDP,  # ClientsTotal : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpV4EnumSubnetClients(
        ServerIpAddress: *const u16,  // LPCWSTR optional
        SubnetAddress: u32,  // DWORD
        ResumeHandle: *mut u32,  // DWORD* in/out
        PreferredMaximum: u32,  // DWORD
        ClientInfo: *mut *mut DHCP_CLIENT_INFO_PB_ARRAY,  // DHCP_CLIENT_INFO_PB_ARRAY** out
        ClientsRead: *mut u32,  // DWORD* out
        ClientsTotal: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpV4EnumSubnetClients([MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress, uint SubnetAddress, ref uint ResumeHandle, uint PreferredMaximum, IntPtr ClientInfo, out uint ClientsRead, out uint ClientsTotal);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpV4EnumSubnetClients' -Namespace Win32 -PassThru
# $api::DhcpV4EnumSubnetClients(ServerIpAddress, SubnetAddress, ResumeHandle, PreferredMaximum, ClientInfo, ClientsRead, ClientsTotal)

#uselib "DHCPSAPI.dll"
#func global DhcpV4EnumSubnetClients "DhcpV4EnumSubnetClients" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DhcpV4EnumSubnetClients ServerIpAddress, SubnetAddress, varptr(ResumeHandle), PreferredMaximum, varptr(ClientInfo), varptr(ClientsRead), varptr(ClientsTotal)   ; 戻り値は stat
; ServerIpAddress : LPCWSTR optional -> "sptr"
; SubnetAddress : DWORD -> "sptr"
; ResumeHandle : DWORD* in/out -> "sptr"
; PreferredMaximum : DWORD -> "sptr"
; ClientInfo : DHCP_CLIENT_INFO_PB_ARRAY** out -> "sptr"
; ClientsRead : DWORD* out -> "sptr"
; ClientsTotal : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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

出力引数:

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

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpV4EnumSubnetClients = dhcpsapi.NewProc("DhcpV4EnumSubnetClients")
)

// ServerIpAddress (LPCWSTR optional), SubnetAddress (DWORD), ResumeHandle (DWORD* in/out), PreferredMaximum (DWORD), ClientInfo (DHCP_CLIENT_INFO_PB_ARRAY** out), ClientsRead (DWORD* out), ClientsTotal (DWORD* out)
r1, _, err := procDhcpV4EnumSubnetClients.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ServerIpAddress))),
	uintptr(SubnetAddress),
	uintptr(ResumeHandle),
	uintptr(PreferredMaximum),
	uintptr(ClientInfo),
	uintptr(ClientsRead),
	uintptr(ClientsTotal),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function DhcpV4EnumSubnetClients(
  ServerIpAddress: PWideChar;   // LPCWSTR optional
  SubnetAddress: DWORD;   // DWORD
  ResumeHandle: Pointer;   // DWORD* in/out
  PreferredMaximum: DWORD;   // DWORD
  ClientInfo: Pointer;   // DHCP_CLIENT_INFO_PB_ARRAY** out
  ClientsRead: Pointer;   // DWORD* out
  ClientsTotal: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpV4EnumSubnetClients';

result := DllCall("DHCPSAPI\DhcpV4EnumSubnetClients"
    , "WStr", ServerIpAddress   ; LPCWSTR optional
    , "UInt", SubnetAddress   ; DWORD
    , "Ptr", ResumeHandle   ; DWORD* in/out
    , "UInt", PreferredMaximum   ; DWORD
    , "Ptr", ClientInfo   ; DHCP_CLIENT_INFO_PB_ARRAY** out
    , "Ptr", ClientsRead   ; DWORD* out
    , "Ptr", ClientsTotal   ; DWORD* out
    , "UInt")   ; return: DWORD

●DhcpV4EnumSubnetClients(ServerIpAddress, SubnetAddress, ResumeHandle, PreferredMaximum, ClientInfo, ClientsRead, ClientsTotal) = DLL("DHCPSAPI.dll", "dword DhcpV4EnumSubnetClients(char*, dword, void*, dword, void*, void*, void*)")
# 呼び出し: DhcpV4EnumSubnetClients(ServerIpAddress, SubnetAddress, ResumeHandle, PreferredMaximum, ClientInfo, ClientsRead, ClientsTotal)
# ServerIpAddress : LPCWSTR optional -> "char*"
# SubnetAddress : DWORD -> "dword"
# ResumeHandle : DWORD* in/out -> "void*"
# PreferredMaximum : DWORD -> "dword"
# ClientInfo : DHCP_CLIENT_INFO_PB_ARRAY** out -> "void*"
# ClientsRead : DWORD* out -> "void*"
# ClientsTotal : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。