ホーム › NetworkManagement.Dhcp › DhcpEnumOptionValuesV5

DhcpEnumOptionValuesV5

関数

クラス/ベンダー指定で指定スコープのDHCPオプション値を列挙する。

DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD DhcpEnumOptionValuesV5(
    LPWSTR ServerIpAddress,   // optional
    DWORD Flags,
    LPWSTR ClassName,   // optional
    LPWSTR VendorName,   // optional
    DHCP_OPTION_SCOPE_INFO* ScopeInfo,
    DWORD* ResumeHandle,
    DWORD PreferredMaximum,
    DHCP_OPTION_VALUE_ARRAY** OptionValues,
    DWORD* OptionsRead,
    DWORD* OptionsTotal
);

パラメーター

名前	型	方向	説明
ServerIpAddress	LPWSTR	inoptional	操作対象DHCPサーバのIPアドレスまたはホスト名(Unicode)。
Flags	DWORD	in	ベンダ固有オプションか等を示すフラグを指定する。
ClassName	LPWSTR	inoptional	列挙対象のユーザクラス名(Unicode)へのポインタ。NULL可。
VendorName	LPWSTR	inoptional	列挙対象のベンダクラス名(Unicode)へのポインタ。NULL可。
ScopeInfo	DHCP_OPTION_SCOPE_INFO*	inout	列挙対象の範囲を示すDHCP_OPTION_SCOPE_INFO構造体へのポインタ。
ResumeHandle	DWORD*	inout	列挙の再開位置を示すDWORDへのポインタ。初回は0を指す。
PreferredMaximum	DWORD	in	一度に取得するオプション値数の上限をバイト数で指定する。
OptionValues	DHCP_OPTION_VALUE_ARRAY**	inout	列挙結果を受け取るDHCP_OPTION_VALUE_ARRAYへのポインタ。
OptionsRead	DWORD*	inout	今回読み取ったオプション値数を受け取るDWORDへのポインタ。
OptionsTotal	DWORD*	inout	未列挙分も含む残りオプション値総数を受け取るDWORDへのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpEnumOptionValuesV5(
    LPWSTR ServerIpAddress,   // optional
    DWORD Flags,
    LPWSTR ClassName,   // optional
    LPWSTR VendorName,   // optional
    DHCP_OPTION_SCOPE_INFO* ScopeInfo,
    DWORD* ResumeHandle,
    DWORD PreferredMaximum,
    DHCP_OPTION_VALUE_ARRAY** OptionValues,
    DWORD* OptionsRead,
    DWORD* OptionsTotal
);

[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpEnumOptionValuesV5(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPWSTR optional
    uint Flags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string ClassName,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string VendorName,   // LPWSTR optional
    IntPtr ScopeInfo,   // DHCP_OPTION_SCOPE_INFO* in/out
    ref uint ResumeHandle,   // DWORD* in/out
    uint PreferredMaximum,   // DWORD
    IntPtr OptionValues,   // DHCP_OPTION_VALUE_ARRAY** in/out
    ref uint OptionsRead,   // DWORD* in/out
    ref uint OptionsTotal   // DWORD* in/out
);

<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpEnumOptionValuesV5(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPWSTR optional
    Flags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> ClassName As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> VendorName As String,   ' LPWSTR optional
    ScopeInfo As IntPtr,   ' DHCP_OPTION_SCOPE_INFO* in/out
    ByRef ResumeHandle As UInteger,   ' DWORD* in/out
    PreferredMaximum As UInteger,   ' DWORD
    OptionValues As IntPtr,   ' DHCP_OPTION_VALUE_ARRAY** in/out
    ByRef OptionsRead As UInteger,   ' DWORD* in/out
    ByRef OptionsTotal As UInteger   ' DWORD* in/out
) As UInteger
End Function

' ServerIpAddress : LPWSTR optional
' Flags : DWORD
' ClassName : LPWSTR optional
' VendorName : LPWSTR optional
' ScopeInfo : DHCP_OPTION_SCOPE_INFO* in/out
' ResumeHandle : DWORD* in/out
' PreferredMaximum : DWORD
' OptionValues : DHCP_OPTION_VALUE_ARRAY** in/out
' OptionsRead : DWORD* in/out
' OptionsTotal : DWORD* in/out
Declare PtrSafe Function DhcpEnumOptionValuesV5 Lib "dhcpsapi" ( _
    ByVal ServerIpAddress As LongPtr, _
    ByVal Flags As Long, _
    ByVal ClassName As LongPtr, _
    ByVal VendorName As LongPtr, _
    ByVal ScopeInfo As LongPtr, _
    ByRef ResumeHandle As Long, _
    ByVal PreferredMaximum As Long, _
    ByVal OptionValues As LongPtr, _
    ByRef OptionsRead As Long, _
    ByRef OptionsTotal As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DhcpEnumOptionValuesV5 = ctypes.windll.dhcpsapi.DhcpEnumOptionValuesV5
DhcpEnumOptionValuesV5.restype = wintypes.DWORD
DhcpEnumOptionValuesV5.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPWSTR optional
    wintypes.DWORD,  # Flags : DWORD
    wintypes.LPCWSTR,  # ClassName : LPWSTR optional
    wintypes.LPCWSTR,  # VendorName : LPWSTR optional
    ctypes.c_void_p,  # ScopeInfo : DHCP_OPTION_SCOPE_INFO* in/out
    ctypes.POINTER(wintypes.DWORD),  # ResumeHandle : DWORD* in/out
    wintypes.DWORD,  # PreferredMaximum : DWORD
    ctypes.c_void_p,  # OptionValues : DHCP_OPTION_VALUE_ARRAY** in/out
    ctypes.POINTER(wintypes.DWORD),  # OptionsRead : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # OptionsTotal : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpEnumOptionValuesV5 = Fiddle::Function.new(
  lib['DhcpEnumOptionValuesV5'],
  [
    Fiddle::TYPE_VOIDP,  # ServerIpAddress : LPWSTR optional
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # ClassName : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # VendorName : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # ScopeInfo : DHCP_OPTION_SCOPE_INFO* in/out
    Fiddle::TYPE_VOIDP,  # ResumeHandle : DWORD* in/out
    -Fiddle::TYPE_INT,  # PreferredMaximum : DWORD
    Fiddle::TYPE_VOIDP,  # OptionValues : DHCP_OPTION_VALUE_ARRAY** in/out
    Fiddle::TYPE_VOIDP,  # OptionsRead : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # OptionsTotal : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpEnumOptionValuesV5(
        ServerIpAddress: *mut u16,  // LPWSTR optional
        Flags: u32,  // DWORD
        ClassName: *mut u16,  // LPWSTR optional
        VendorName: *mut u16,  // LPWSTR optional
        ScopeInfo: *mut DHCP_OPTION_SCOPE_INFO,  // DHCP_OPTION_SCOPE_INFO* in/out
        ResumeHandle: *mut u32,  // DWORD* in/out
        PreferredMaximum: u32,  // DWORD
        OptionValues: *mut *mut DHCP_OPTION_VALUE_ARRAY,  // DHCP_OPTION_VALUE_ARRAY** in/out
        OptionsRead: *mut u32,  // DWORD* in/out
        OptionsTotal: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpEnumOptionValuesV5([MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress, uint Flags, [MarshalAs(UnmanagedType.LPWStr)] string ClassName, [MarshalAs(UnmanagedType.LPWStr)] string VendorName, IntPtr ScopeInfo, ref uint ResumeHandle, uint PreferredMaximum, IntPtr OptionValues, ref uint OptionsRead, ref uint OptionsTotal);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpEnumOptionValuesV5' -Namespace Win32 -PassThru
# $api::DhcpEnumOptionValuesV5(ServerIpAddress, Flags, ClassName, VendorName, ScopeInfo, ResumeHandle, PreferredMaximum, OptionValues, OptionsRead, OptionsTotal)

#uselib "DHCPSAPI.dll"
#func global DhcpEnumOptionValuesV5 "DhcpEnumOptionValuesV5" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DhcpEnumOptionValuesV5 ServerIpAddress, Flags, ClassName, VendorName, varptr(ScopeInfo), varptr(ResumeHandle), PreferredMaximum, varptr(OptionValues), varptr(OptionsRead), varptr(OptionsTotal)   ; 戻り値は stat
; ServerIpAddress : LPWSTR optional -> "sptr"
; Flags : DWORD -> "sptr"
; ClassName : LPWSTR optional -> "sptr"
; VendorName : LPWSTR optional -> "sptr"
; ScopeInfo : DHCP_OPTION_SCOPE_INFO* in/out -> "sptr"
; ResumeHandle : DWORD* in/out -> "sptr"
; PreferredMaximum : DWORD -> "sptr"
; OptionValues : DHCP_OPTION_VALUE_ARRAY** in/out -> "sptr"
; OptionsRead : DWORD* in/out -> "sptr"
; OptionsTotal : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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

出力引数:

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

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpEnumOptionValuesV5 = dhcpsapi.NewProc("DhcpEnumOptionValuesV5")
)

// ServerIpAddress (LPWSTR optional), Flags (DWORD), ClassName (LPWSTR optional), VendorName (LPWSTR optional), ScopeInfo (DHCP_OPTION_SCOPE_INFO* in/out), ResumeHandle (DWORD* in/out), PreferredMaximum (DWORD), OptionValues (DHCP_OPTION_VALUE_ARRAY** in/out), OptionsRead (DWORD* in/out), OptionsTotal (DWORD* in/out)
r1, _, err := procDhcpEnumOptionValuesV5.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ServerIpAddress))),
	uintptr(Flags),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ClassName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(VendorName))),
	uintptr(ScopeInfo),
	uintptr(ResumeHandle),
	uintptr(PreferredMaximum),
	uintptr(OptionValues),
	uintptr(OptionsRead),
	uintptr(OptionsTotal),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function DhcpEnumOptionValuesV5(
  ServerIpAddress: PWideChar;   // LPWSTR optional
  Flags: DWORD;   // DWORD
  ClassName: PWideChar;   // LPWSTR optional
  VendorName: PWideChar;   // LPWSTR optional
  ScopeInfo: Pointer;   // DHCP_OPTION_SCOPE_INFO* in/out
  ResumeHandle: Pointer;   // DWORD* in/out
  PreferredMaximum: DWORD;   // DWORD
  OptionValues: Pointer;   // DHCP_OPTION_VALUE_ARRAY** in/out
  OptionsRead: Pointer;   // DWORD* in/out
  OptionsTotal: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpEnumOptionValuesV5';

result := DllCall("DHCPSAPI\DhcpEnumOptionValuesV5"
    , "WStr", ServerIpAddress   ; LPWSTR optional
    , "UInt", Flags   ; DWORD
    , "WStr", ClassName   ; LPWSTR optional
    , "WStr", VendorName   ; LPWSTR optional
    , "Ptr", ScopeInfo   ; DHCP_OPTION_SCOPE_INFO* in/out
    , "Ptr", ResumeHandle   ; DWORD* in/out
    , "UInt", PreferredMaximum   ; DWORD
    , "Ptr", OptionValues   ; DHCP_OPTION_VALUE_ARRAY** in/out
    , "Ptr", OptionsRead   ; DWORD* in/out
    , "Ptr", OptionsTotal   ; DWORD* in/out
    , "UInt")   ; return: DWORD

●DhcpEnumOptionValuesV5(ServerIpAddress, Flags, ClassName, VendorName, ScopeInfo, ResumeHandle, PreferredMaximum, OptionValues, OptionsRead, OptionsTotal) = DLL("DHCPSAPI.dll", "dword DhcpEnumOptionValuesV5(char*, dword, char*, char*, void*, void*, dword, void*, void*, void*)")
# 呼び出し: DhcpEnumOptionValuesV5(ServerIpAddress, Flags, ClassName, VendorName, ScopeInfo, ResumeHandle, PreferredMaximum, OptionValues, OptionsRead, OptionsTotal)
# ServerIpAddress : LPWSTR optional -> "char*"
# Flags : DWORD -> "dword"
# ClassName : LPWSTR optional -> "char*"
# VendorName : LPWSTR optional -> "char*"
# ScopeInfo : DHCP_OPTION_SCOPE_INFO* in/out -> "void*"
# ResumeHandle : DWORD* in/out -> "void*"
# PreferredMaximum : DWORD -> "dword"
# OptionValues : DHCP_OPTION_VALUE_ARRAY** in/out -> "void*"
# OptionsRead : DWORD* in/out -> "void*"
# OptionsTotal : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。