ホーム › NetworkManagement.Dhcp › DhcpEnumOptionValues

DhcpEnumOptionValues

関数

指定スコープに設定されたDHCPオプション値を列挙する。

DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD DhcpEnumOptionValues(
    LPCWSTR ServerIpAddress,   // optional
    const DHCP_OPTION_SCOPE_INFO* ScopeInfo,
    DWORD* ResumeHandle,
    DWORD PreferredMaximum,
    DHCP_OPTION_VALUE_ARRAY** OptionValues,
    DWORD* OptionsRead,
    DWORD* OptionsTotal
);

パラメーター

名前	型	方向
ServerIpAddress	LPCWSTR	inoptional
ScopeInfo	DHCP_OPTION_SCOPE_INFO*	in
ResumeHandle	DWORD*	inout
PreferredMaximum	DWORD	in
OptionValues	DHCP_OPTION_VALUE_ARRAY**	inout
OptionsRead	DWORD*	inout
OptionsTotal	DWORD*	inout

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpEnumOptionValues(
    LPCWSTR ServerIpAddress,   // optional
    const 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 DhcpEnumOptionValues(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPCWSTR optional
    IntPtr ScopeInfo,   // DHCP_OPTION_SCOPE_INFO*
    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 DhcpEnumOptionValues(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPCWSTR optional
    ScopeInfo As IntPtr,   ' DHCP_OPTION_SCOPE_INFO*
    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 : LPCWSTR optional
' ScopeInfo : DHCP_OPTION_SCOPE_INFO*
' ResumeHandle : DWORD* in/out
' PreferredMaximum : DWORD
' OptionValues : DHCP_OPTION_VALUE_ARRAY** in/out
' OptionsRead : DWORD* in/out
' OptionsTotal : DWORD* in/out
Declare PtrSafe Function DhcpEnumOptionValues Lib "dhcpsapi" ( _
    ByVal ServerIpAddress 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

DhcpEnumOptionValues = ctypes.windll.dhcpsapi.DhcpEnumOptionValues
DhcpEnumOptionValues.restype = wintypes.DWORD
DhcpEnumOptionValues.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPCWSTR optional
    ctypes.c_void_p,  # ScopeInfo : DHCP_OPTION_SCOPE_INFO*
    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')
DhcpEnumOptionValues = Fiddle::Function.new(
  lib['DhcpEnumOptionValues'],
  [
    Fiddle::TYPE_VOIDP,  # ServerIpAddress : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # ScopeInfo : DHCP_OPTION_SCOPE_INFO*
    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 DhcpEnumOptionValues(
        ServerIpAddress: *const u16,  // LPCWSTR optional
        ScopeInfo: *const DHCP_OPTION_SCOPE_INFO,  // DHCP_OPTION_SCOPE_INFO*
        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 DhcpEnumOptionValues([MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress, IntPtr ScopeInfo, ref uint ResumeHandle, uint PreferredMaximum, IntPtr OptionValues, ref uint OptionsRead, ref uint OptionsTotal);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpEnumOptionValues' -Namespace Win32 -PassThru
# $api::DhcpEnumOptionValues(ServerIpAddress, ScopeInfo, ResumeHandle, PreferredMaximum, OptionValues, OptionsRead, OptionsTotal)

#uselib "DHCPSAPI.dll"
#func global DhcpEnumOptionValues "DhcpEnumOptionValues" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DhcpEnumOptionValues ServerIpAddress, varptr(ScopeInfo), varptr(ResumeHandle), PreferredMaximum, varptr(OptionValues), varptr(OptionsRead), varptr(OptionsTotal)   ; 戻り値は stat
; ServerIpAddress : LPCWSTR optional -> "sptr"
; ScopeInfo : DHCP_OPTION_SCOPE_INFO* -> "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 DhcpEnumOptionValues "DhcpEnumOptionValues" wstr, var, var, int, var, var, var
; res = DhcpEnumOptionValues(ServerIpAddress, ScopeInfo, ResumeHandle, PreferredMaximum, OptionValues, OptionsRead, OptionsTotal)
; ServerIpAddress : LPCWSTR optional -> "wstr"
; ScopeInfo : DHCP_OPTION_SCOPE_INFO* -> "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 DhcpEnumOptionValues "DhcpEnumOptionValues" wstr, sptr, sptr, int, sptr, sptr, sptr
; res = DhcpEnumOptionValues(ServerIpAddress, varptr(ScopeInfo), varptr(ResumeHandle), PreferredMaximum, varptr(OptionValues), varptr(OptionsRead), varptr(OptionsTotal))
; ServerIpAddress : LPCWSTR optional -> "wstr"
; ScopeInfo : DHCP_OPTION_SCOPE_INFO* -> "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 DhcpEnumOptionValues(LPCWSTR ServerIpAddress, DHCP_OPTION_SCOPE_INFO* ScopeInfo, DWORD* ResumeHandle, DWORD PreferredMaximum, DHCP_OPTION_VALUE_ARRAY** OptionValues, DWORD* OptionsRead, DWORD* OptionsTotal)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpEnumOptionValues "DhcpEnumOptionValues" wstr, var, var, int, var, var, var
; res = DhcpEnumOptionValues(ServerIpAddress, ScopeInfo, ResumeHandle, PreferredMaximum, OptionValues, OptionsRead, OptionsTotal)
; ServerIpAddress : LPCWSTR optional -> "wstr"
; ScopeInfo : DHCP_OPTION_SCOPE_INFO* -> "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 DhcpEnumOptionValues(LPCWSTR ServerIpAddress, DHCP_OPTION_SCOPE_INFO* ScopeInfo, DWORD* ResumeHandle, DWORD PreferredMaximum, DHCP_OPTION_VALUE_ARRAY** OptionValues, DWORD* OptionsRead, DWORD* OptionsTotal)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpEnumOptionValues "DhcpEnumOptionValues" wstr, intptr, intptr, int, intptr, intptr, intptr
; res = DhcpEnumOptionValues(ServerIpAddress, varptr(ScopeInfo), varptr(ResumeHandle), PreferredMaximum, varptr(OptionValues), varptr(OptionsRead), varptr(OptionsTotal))
; ServerIpAddress : LPCWSTR optional -> "wstr"
; ScopeInfo : DHCP_OPTION_SCOPE_INFO* -> "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")
	procDhcpEnumOptionValues = dhcpsapi.NewProc("DhcpEnumOptionValues")
)

// ServerIpAddress (LPCWSTR optional), ScopeInfo (DHCP_OPTION_SCOPE_INFO*), ResumeHandle (DWORD* in/out), PreferredMaximum (DWORD), OptionValues (DHCP_OPTION_VALUE_ARRAY** in/out), OptionsRead (DWORD* in/out), OptionsTotal (DWORD* in/out)
r1, _, err := procDhcpEnumOptionValues.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ServerIpAddress))),
	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 DhcpEnumOptionValues(
  ServerIpAddress: PWideChar;   // LPCWSTR optional
  ScopeInfo: Pointer;   // DHCP_OPTION_SCOPE_INFO*
  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 'DhcpEnumOptionValues';

result := DllCall("DHCPSAPI\DhcpEnumOptionValues"
    , "WStr", ServerIpAddress   ; LPCWSTR optional
    , "Ptr", ScopeInfo   ; DHCP_OPTION_SCOPE_INFO*
    , "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

●DhcpEnumOptionValues(ServerIpAddress, ScopeInfo, ResumeHandle, PreferredMaximum, OptionValues, OptionsRead, OptionsTotal) = DLL("DHCPSAPI.dll", "dword DhcpEnumOptionValues(char*, void*, void*, dword, void*, void*, void*)")
# 呼び出し: DhcpEnumOptionValues(ServerIpAddress, ScopeInfo, ResumeHandle, PreferredMaximum, OptionValues, OptionsRead, OptionsTotal)
# ServerIpAddress : LPCWSTR optional -> "char*"
# ScopeInfo : DHCP_OPTION_SCOPE_INFO* -> "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)。