ホーム › NetworkManagement.Dhcp › DhcpEnumFilterV4

DhcpEnumFilterV4

関数

DHCPv4サーバーの許可/拒否フィルター一覧を列挙する。

DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD DhcpEnumFilterV4(
    LPCWSTR ServerIpAddress,   // optional
    DHCP_ADDR_PATTERN* ResumeHandle,
    DWORD PreferredMaximum,
    DHCP_FILTER_LIST_TYPE ListType,
    DHCP_FILTER_ENUM_INFO** EnumFilterInfo,
    DWORD* ElementsRead,
    DWORD* ElementsTotal
);

パラメーター

名前	型	方向	説明
ServerIpAddress	LPCWSTR	inoptional	操作対象DHCPサーバのIPアドレスまたはホスト名(Unicode)。
ResumeHandle	DHCP_ADDR_PATTERN*	inout	列挙の再開位置を示すDHCP_ADDR_PATTERN構造体へのポインタ。初回はNULL相当。
PreferredMaximum	DWORD	in	一度に取得するフィルタ数の上限をバイト数で指定する。
ListType	DHCP_FILTER_LIST_TYPE	in	列挙対象が許可リストか拒否リストかを示すDHCP_FILTER_LIST_TYPE値。
EnumFilterInfo	DHCP_FILTER_ENUM_INFO**	out	列挙結果を受け取るDHCP_FILTER_ENUM_INFO配列へのポインタ。
ElementsRead	DWORD*	out	今回読み取ったフィルタ数を受け取るDWORDへのポインタ。
ElementsTotal	DWORD*	out	未列挙分も含む残りフィルタ総数を受け取るDWORDへのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpEnumFilterV4(
    LPCWSTR ServerIpAddress,   // optional
    DHCP_ADDR_PATTERN* ResumeHandle,
    DWORD PreferredMaximum,
    DHCP_FILTER_LIST_TYPE ListType,
    DHCP_FILTER_ENUM_INFO** EnumFilterInfo,
    DWORD* ElementsRead,
    DWORD* ElementsTotal
);

[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpEnumFilterV4(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPCWSTR optional
    IntPtr ResumeHandle,   // DHCP_ADDR_PATTERN* in/out
    uint PreferredMaximum,   // DWORD
    int ListType,   // DHCP_FILTER_LIST_TYPE
    IntPtr EnumFilterInfo,   // DHCP_FILTER_ENUM_INFO** out
    out uint ElementsRead,   // DWORD* out
    out uint ElementsTotal   // DWORD* out
);

<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpEnumFilterV4(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPCWSTR optional
    ResumeHandle As IntPtr,   ' DHCP_ADDR_PATTERN* in/out
    PreferredMaximum As UInteger,   ' DWORD
    ListType As Integer,   ' DHCP_FILTER_LIST_TYPE
    EnumFilterInfo As IntPtr,   ' DHCP_FILTER_ENUM_INFO** out
    <Out> ByRef ElementsRead As UInteger,   ' DWORD* out
    <Out> ByRef ElementsTotal As UInteger   ' DWORD* out
) As UInteger
End Function

' ServerIpAddress : LPCWSTR optional
' ResumeHandle : DHCP_ADDR_PATTERN* in/out
' PreferredMaximum : DWORD
' ListType : DHCP_FILTER_LIST_TYPE
' EnumFilterInfo : DHCP_FILTER_ENUM_INFO** out
' ElementsRead : DWORD* out
' ElementsTotal : DWORD* out
Declare PtrSafe Function DhcpEnumFilterV4 Lib "dhcpsapi" ( _
    ByVal ServerIpAddress As LongPtr, _
    ByVal ResumeHandle As LongPtr, _
    ByVal PreferredMaximum As Long, _
    ByVal ListType As Long, _
    ByVal EnumFilterInfo As LongPtr, _
    ByRef ElementsRead As Long, _
    ByRef ElementsTotal As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DhcpEnumFilterV4 = ctypes.windll.dhcpsapi.DhcpEnumFilterV4
DhcpEnumFilterV4.restype = wintypes.DWORD
DhcpEnumFilterV4.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPCWSTR optional
    ctypes.c_void_p,  # ResumeHandle : DHCP_ADDR_PATTERN* in/out
    wintypes.DWORD,  # PreferredMaximum : DWORD
    ctypes.c_int,  # ListType : DHCP_FILTER_LIST_TYPE
    ctypes.c_void_p,  # EnumFilterInfo : DHCP_FILTER_ENUM_INFO** out
    ctypes.POINTER(wintypes.DWORD),  # ElementsRead : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # ElementsTotal : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpEnumFilterV4 = Fiddle::Function.new(
  lib['DhcpEnumFilterV4'],
  [
    Fiddle::TYPE_VOIDP,  # ServerIpAddress : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # ResumeHandle : DHCP_ADDR_PATTERN* in/out
    -Fiddle::TYPE_INT,  # PreferredMaximum : DWORD
    Fiddle::TYPE_INT,  # ListType : DHCP_FILTER_LIST_TYPE
    Fiddle::TYPE_VOIDP,  # EnumFilterInfo : DHCP_FILTER_ENUM_INFO** out
    Fiddle::TYPE_VOIDP,  # ElementsRead : DWORD* out
    Fiddle::TYPE_VOIDP,  # ElementsTotal : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpEnumFilterV4(
        ServerIpAddress: *const u16,  // LPCWSTR optional
        ResumeHandle: *mut DHCP_ADDR_PATTERN,  // DHCP_ADDR_PATTERN* in/out
        PreferredMaximum: u32,  // DWORD
        ListType: i32,  // DHCP_FILTER_LIST_TYPE
        EnumFilterInfo: *mut *mut DHCP_FILTER_ENUM_INFO,  // DHCP_FILTER_ENUM_INFO** out
        ElementsRead: *mut u32,  // DWORD* out
        ElementsTotal: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpEnumFilterV4([MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress, IntPtr ResumeHandle, uint PreferredMaximum, int ListType, IntPtr EnumFilterInfo, out uint ElementsRead, out uint ElementsTotal);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpEnumFilterV4' -Namespace Win32 -PassThru
# $api::DhcpEnumFilterV4(ServerIpAddress, ResumeHandle, PreferredMaximum, ListType, EnumFilterInfo, ElementsRead, ElementsTotal)

#uselib "DHCPSAPI.dll"
#func global DhcpEnumFilterV4 "DhcpEnumFilterV4" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DhcpEnumFilterV4 ServerIpAddress, varptr(ResumeHandle), PreferredMaximum, ListType, varptr(EnumFilterInfo), varptr(ElementsRead), varptr(ElementsTotal)   ; 戻り値は stat
; ServerIpAddress : LPCWSTR optional -> "sptr"
; ResumeHandle : DHCP_ADDR_PATTERN* in/out -> "sptr"
; PreferredMaximum : DWORD -> "sptr"
; ListType : DHCP_FILTER_LIST_TYPE -> "sptr"
; EnumFilterInfo : DHCP_FILTER_ENUM_INFO** out -> "sptr"
; ElementsRead : DWORD* out -> "sptr"
; ElementsTotal : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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

出力引数:

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

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpEnumFilterV4 = dhcpsapi.NewProc("DhcpEnumFilterV4")
)

// ServerIpAddress (LPCWSTR optional), ResumeHandle (DHCP_ADDR_PATTERN* in/out), PreferredMaximum (DWORD), ListType (DHCP_FILTER_LIST_TYPE), EnumFilterInfo (DHCP_FILTER_ENUM_INFO** out), ElementsRead (DWORD* out), ElementsTotal (DWORD* out)
r1, _, err := procDhcpEnumFilterV4.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ServerIpAddress))),
	uintptr(ResumeHandle),
	uintptr(PreferredMaximum),
	uintptr(ListType),
	uintptr(EnumFilterInfo),
	uintptr(ElementsRead),
	uintptr(ElementsTotal),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function DhcpEnumFilterV4(
  ServerIpAddress: PWideChar;   // LPCWSTR optional
  ResumeHandle: Pointer;   // DHCP_ADDR_PATTERN* in/out
  PreferredMaximum: DWORD;   // DWORD
  ListType: Integer;   // DHCP_FILTER_LIST_TYPE
  EnumFilterInfo: Pointer;   // DHCP_FILTER_ENUM_INFO** out
  ElementsRead: Pointer;   // DWORD* out
  ElementsTotal: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpEnumFilterV4';

result := DllCall("DHCPSAPI\DhcpEnumFilterV4"
    , "WStr", ServerIpAddress   ; LPCWSTR optional
    , "Ptr", ResumeHandle   ; DHCP_ADDR_PATTERN* in/out
    , "UInt", PreferredMaximum   ; DWORD
    , "Int", ListType   ; DHCP_FILTER_LIST_TYPE
    , "Ptr", EnumFilterInfo   ; DHCP_FILTER_ENUM_INFO** out
    , "Ptr", ElementsRead   ; DWORD* out
    , "Ptr", ElementsTotal   ; DWORD* out
    , "UInt")   ; return: DWORD

●DhcpEnumFilterV4(ServerIpAddress, ResumeHandle, PreferredMaximum, ListType, EnumFilterInfo, ElementsRead, ElementsTotal) = DLL("DHCPSAPI.dll", "dword DhcpEnumFilterV4(char*, void*, dword, int, void*, void*, void*)")
# 呼び出し: DhcpEnumFilterV4(ServerIpAddress, ResumeHandle, PreferredMaximum, ListType, EnumFilterInfo, ElementsRead, ElementsTotal)
# ServerIpAddress : LPCWSTR optional -> "char*"
# ResumeHandle : DHCP_ADDR_PATTERN* in/out -> "void*"
# PreferredMaximum : DWORD -> "dword"
# ListType : DHCP_FILTER_LIST_TYPE -> "int"
# EnumFilterInfo : DHCP_FILTER_ENUM_INFO** out -> "void*"
# ElementsRead : DWORD* out -> "void*"
# ElementsTotal : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。