Win32 API 日本語リファレンス
ホームNetworkManagement.Dhcp › DhcpV4GetOptionValue

DhcpV4GetOptionValue

関数
指定スコープのIPv4 DHCPオプション値を取得する。
DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2012

シグネチャ

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

DWORD DhcpV4GetOptionValue(
    LPWSTR ServerIpAddress,   // optional
    DWORD Flags,
    DWORD OptionID,
    LPWSTR PolicyName,   // optional
    LPWSTR VendorName,   // optional
    DHCP_OPTION_SCOPE_INFO* ScopeInfo,
    DHCP_OPTION_VALUE** OptionValue
);

パラメーター

名前方向
ServerIpAddressLPWSTRinoptional
FlagsDWORDin
OptionIDDWORDin
PolicyNameLPWSTRinoptional
VendorNameLPWSTRinoptional
ScopeInfoDHCP_OPTION_SCOPE_INFO*inout
OptionValueDHCP_OPTION_VALUE**inout

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpV4GetOptionValue(
    LPWSTR ServerIpAddress,   // optional
    DWORD Flags,
    DWORD OptionID,
    LPWSTR PolicyName,   // optional
    LPWSTR VendorName,   // optional
    DHCP_OPTION_SCOPE_INFO* ScopeInfo,
    DHCP_OPTION_VALUE** OptionValue
);
[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpV4GetOptionValue(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPWSTR optional
    uint Flags,   // DWORD
    uint OptionID,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string PolicyName,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string VendorName,   // LPWSTR optional
    IntPtr ScopeInfo,   // DHCP_OPTION_SCOPE_INFO* in/out
    IntPtr OptionValue   // DHCP_OPTION_VALUE** in/out
);
<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpV4GetOptionValue(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPWSTR optional
    Flags As UInteger,   ' DWORD
    OptionID As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> PolicyName As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> VendorName As String,   ' LPWSTR optional
    ScopeInfo As IntPtr,   ' DHCP_OPTION_SCOPE_INFO* in/out
    OptionValue As IntPtr   ' DHCP_OPTION_VALUE** in/out
) As UInteger
End Function
' ServerIpAddress : LPWSTR optional
' Flags : DWORD
' OptionID : DWORD
' PolicyName : LPWSTR optional
' VendorName : LPWSTR optional
' ScopeInfo : DHCP_OPTION_SCOPE_INFO* in/out
' OptionValue : DHCP_OPTION_VALUE** in/out
Declare PtrSafe Function DhcpV4GetOptionValue Lib "dhcpsapi" ( _
    ByVal ServerIpAddress As LongPtr, _
    ByVal Flags As Long, _
    ByVal OptionID As Long, _
    ByVal PolicyName As LongPtr, _
    ByVal VendorName As LongPtr, _
    ByVal ScopeInfo As LongPtr, _
    ByVal OptionValue As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DhcpV4GetOptionValue = ctypes.windll.dhcpsapi.DhcpV4GetOptionValue
DhcpV4GetOptionValue.restype = wintypes.DWORD
DhcpV4GetOptionValue.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPWSTR optional
    wintypes.DWORD,  # Flags : DWORD
    wintypes.DWORD,  # OptionID : DWORD
    wintypes.LPCWSTR,  # PolicyName : LPWSTR optional
    wintypes.LPCWSTR,  # VendorName : LPWSTR optional
    ctypes.c_void_p,  # ScopeInfo : DHCP_OPTION_SCOPE_INFO* in/out
    ctypes.c_void_p,  # OptionValue : DHCP_OPTION_VALUE** in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpV4GetOptionValue = Fiddle::Function.new(
  lib['DhcpV4GetOptionValue'],
  [
    Fiddle::TYPE_VOIDP,  # ServerIpAddress : LPWSTR optional
    -Fiddle::TYPE_INT,  # Flags : DWORD
    -Fiddle::TYPE_INT,  # OptionID : DWORD
    Fiddle::TYPE_VOIDP,  # PolicyName : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # VendorName : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # ScopeInfo : DHCP_OPTION_SCOPE_INFO* in/out
    Fiddle::TYPE_VOIDP,  # OptionValue : DHCP_OPTION_VALUE** in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpV4GetOptionValue(
        ServerIpAddress: *mut u16,  // LPWSTR optional
        Flags: u32,  // DWORD
        OptionID: u32,  // DWORD
        PolicyName: *mut u16,  // LPWSTR optional
        VendorName: *mut u16,  // LPWSTR optional
        ScopeInfo: *mut DHCP_OPTION_SCOPE_INFO,  // DHCP_OPTION_SCOPE_INFO* in/out
        OptionValue: *mut *mut DHCP_OPTION_VALUE  // DHCP_OPTION_VALUE** in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpV4GetOptionValue([MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress, uint Flags, uint OptionID, [MarshalAs(UnmanagedType.LPWStr)] string PolicyName, [MarshalAs(UnmanagedType.LPWStr)] string VendorName, IntPtr ScopeInfo, IntPtr OptionValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpV4GetOptionValue' -Namespace Win32 -PassThru
# $api::DhcpV4GetOptionValue(ServerIpAddress, Flags, OptionID, PolicyName, VendorName, ScopeInfo, OptionValue)
#uselib "DHCPSAPI.dll"
#func global DhcpV4GetOptionValue "DhcpV4GetOptionValue" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DhcpV4GetOptionValue ServerIpAddress, Flags, OptionID, PolicyName, VendorName, varptr(ScopeInfo), varptr(OptionValue)   ; 戻り値は stat
; ServerIpAddress : LPWSTR optional -> "sptr"
; Flags : DWORD -> "sptr"
; OptionID : DWORD -> "sptr"
; PolicyName : LPWSTR optional -> "sptr"
; VendorName : LPWSTR optional -> "sptr"
; ScopeInfo : DHCP_OPTION_SCOPE_INFO* in/out -> "sptr"
; OptionValue : DHCP_OPTION_VALUE** in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "DHCPSAPI.dll"
#cfunc global DhcpV4GetOptionValue "DhcpV4GetOptionValue" wstr, int, int, wstr, wstr, var, var
; res = DhcpV4GetOptionValue(ServerIpAddress, Flags, OptionID, PolicyName, VendorName, ScopeInfo, OptionValue)
; ServerIpAddress : LPWSTR optional -> "wstr"
; Flags : DWORD -> "int"
; OptionID : DWORD -> "int"
; PolicyName : LPWSTR optional -> "wstr"
; VendorName : LPWSTR optional -> "wstr"
; ScopeInfo : DHCP_OPTION_SCOPE_INFO* in/out -> "var"
; OptionValue : DHCP_OPTION_VALUE** in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD DhcpV4GetOptionValue(LPWSTR ServerIpAddress, DWORD Flags, DWORD OptionID, LPWSTR PolicyName, LPWSTR VendorName, DHCP_OPTION_SCOPE_INFO* ScopeInfo, DHCP_OPTION_VALUE** OptionValue)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpV4GetOptionValue "DhcpV4GetOptionValue" wstr, int, int, wstr, wstr, var, var
; res = DhcpV4GetOptionValue(ServerIpAddress, Flags, OptionID, PolicyName, VendorName, ScopeInfo, OptionValue)
; ServerIpAddress : LPWSTR optional -> "wstr"
; Flags : DWORD -> "int"
; OptionID : DWORD -> "int"
; PolicyName : LPWSTR optional -> "wstr"
; VendorName : LPWSTR optional -> "wstr"
; ScopeInfo : DHCP_OPTION_SCOPE_INFO* in/out -> "var"
; OptionValue : DHCP_OPTION_VALUE** in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpV4GetOptionValue = dhcpsapi.NewProc("DhcpV4GetOptionValue")
)

// ServerIpAddress (LPWSTR optional), Flags (DWORD), OptionID (DWORD), PolicyName (LPWSTR optional), VendorName (LPWSTR optional), ScopeInfo (DHCP_OPTION_SCOPE_INFO* in/out), OptionValue (DHCP_OPTION_VALUE** in/out)
r1, _, err := procDhcpV4GetOptionValue.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ServerIpAddress))),
	uintptr(Flags),
	uintptr(OptionID),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(PolicyName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(VendorName))),
	uintptr(ScopeInfo),
	uintptr(OptionValue),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DhcpV4GetOptionValue(
  ServerIpAddress: PWideChar;   // LPWSTR optional
  Flags: DWORD;   // DWORD
  OptionID: DWORD;   // DWORD
  PolicyName: PWideChar;   // LPWSTR optional
  VendorName: PWideChar;   // LPWSTR optional
  ScopeInfo: Pointer;   // DHCP_OPTION_SCOPE_INFO* in/out
  OptionValue: Pointer   // DHCP_OPTION_VALUE** in/out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpV4GetOptionValue';
result := DllCall("DHCPSAPI\DhcpV4GetOptionValue"
    , "WStr", ServerIpAddress   ; LPWSTR optional
    , "UInt", Flags   ; DWORD
    , "UInt", OptionID   ; DWORD
    , "WStr", PolicyName   ; LPWSTR optional
    , "WStr", VendorName   ; LPWSTR optional
    , "Ptr", ScopeInfo   ; DHCP_OPTION_SCOPE_INFO* in/out
    , "Ptr", OptionValue   ; DHCP_OPTION_VALUE** in/out
    , "UInt")   ; return: DWORD
●DhcpV4GetOptionValue(ServerIpAddress, Flags, OptionID, PolicyName, VendorName, ScopeInfo, OptionValue) = DLL("DHCPSAPI.dll", "dword DhcpV4GetOptionValue(char*, dword, dword, char*, char*, void*, void*)")
# 呼び出し: DhcpV4GetOptionValue(ServerIpAddress, Flags, OptionID, PolicyName, VendorName, ScopeInfo, OptionValue)
# ServerIpAddress : LPWSTR optional -> "char*"
# Flags : DWORD -> "dword"
# OptionID : DWORD -> "dword"
# PolicyName : LPWSTR optional -> "char*"
# VendorName : LPWSTR optional -> "char*"
# ScopeInfo : DHCP_OPTION_SCOPE_INFO* in/out -> "void*"
# OptionValue : DHCP_OPTION_VALUE** in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。