ホーム › NetworkManagement.Dhcp › DhcpGetOptionInfoV6

DhcpGetOptionInfoV6

関数

クラス/ベンダー指定でIPv6向けDHCPオプション定義情報を取得する。

DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD DhcpGetOptionInfoV6(
    LPWSTR ServerIpAddress,   // optional
    DWORD Flags,
    DWORD OptionID,
    LPWSTR ClassName,   // optional
    LPWSTR VendorName,   // optional
    DHCP_OPTION** OptionInfo
);

パラメーター

名前	型	方向	説明
ServerIpAddress	LPWSTR	inoptional	対象DHCPv6サーバーのIPアドレスを示すUnicode文字列。ローカルならNULL可。
Flags	DWORD	in	ベンダー固有か否かを示すフラグ。
OptionID	DWORD	in	情報を取得するオプションの識別子(コード)。
ClassName	LPWSTR	inoptional	オプションが属するクラス名。既定クラスならNULL可。
VendorName	LPWSTR	inoptional	ベンダー固有の場合のベンダー名。標準ならNULL可。
OptionInfo	DHCP_OPTION**	inout	取得したオプション定義のDHCP_OPTIONへのポインタを受け取る二重ポインタ。使用後は解放する。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpGetOptionInfoV6(
    LPWSTR ServerIpAddress,   // optional
    DWORD Flags,
    DWORD OptionID,
    LPWSTR ClassName,   // optional
    LPWSTR VendorName,   // optional
    DHCP_OPTION** OptionInfo
);

[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpGetOptionInfoV6(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPWSTR optional
    uint Flags,   // DWORD
    uint OptionID,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string ClassName,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string VendorName,   // LPWSTR optional
    IntPtr OptionInfo   // DHCP_OPTION** in/out
);

<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpGetOptionInfoV6(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPWSTR optional
    Flags As UInteger,   ' DWORD
    OptionID As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> ClassName As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> VendorName As String,   ' LPWSTR optional
    OptionInfo As IntPtr   ' DHCP_OPTION** in/out
) As UInteger
End Function

' ServerIpAddress : LPWSTR optional
' Flags : DWORD
' OptionID : DWORD
' ClassName : LPWSTR optional
' VendorName : LPWSTR optional
' OptionInfo : DHCP_OPTION** in/out
Declare PtrSafe Function DhcpGetOptionInfoV6 Lib "dhcpsapi" ( _
    ByVal ServerIpAddress As LongPtr, _
    ByVal Flags As Long, _
    ByVal OptionID As Long, _
    ByVal ClassName As LongPtr, _
    ByVal VendorName As LongPtr, _
    ByVal OptionInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DhcpGetOptionInfoV6 = ctypes.windll.dhcpsapi.DhcpGetOptionInfoV6
DhcpGetOptionInfoV6.restype = wintypes.DWORD
DhcpGetOptionInfoV6.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPWSTR optional
    wintypes.DWORD,  # Flags : DWORD
    wintypes.DWORD,  # OptionID : DWORD
    wintypes.LPCWSTR,  # ClassName : LPWSTR optional
    wintypes.LPCWSTR,  # VendorName : LPWSTR optional
    ctypes.c_void_p,  # OptionInfo : DHCP_OPTION** in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpGetOptionInfoV6 = Fiddle::Function.new(
  lib['DhcpGetOptionInfoV6'],
  [
    Fiddle::TYPE_VOIDP,  # ServerIpAddress : LPWSTR optional
    -Fiddle::TYPE_INT,  # Flags : DWORD
    -Fiddle::TYPE_INT,  # OptionID : DWORD
    Fiddle::TYPE_VOIDP,  # ClassName : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # VendorName : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # OptionInfo : DHCP_OPTION** in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpGetOptionInfoV6(
        ServerIpAddress: *mut u16,  // LPWSTR optional
        Flags: u32,  // DWORD
        OptionID: u32,  // DWORD
        ClassName: *mut u16,  // LPWSTR optional
        VendorName: *mut u16,  // LPWSTR optional
        OptionInfo: *mut *mut DHCP_OPTION  // DHCP_OPTION** in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpGetOptionInfoV6([MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress, uint Flags, uint OptionID, [MarshalAs(UnmanagedType.LPWStr)] string ClassName, [MarshalAs(UnmanagedType.LPWStr)] string VendorName, IntPtr OptionInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpGetOptionInfoV6' -Namespace Win32 -PassThru
# $api::DhcpGetOptionInfoV6(ServerIpAddress, Flags, OptionID, ClassName, VendorName, OptionInfo)

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

出力引数:

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

出力引数:

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

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpGetOptionInfoV6 = dhcpsapi.NewProc("DhcpGetOptionInfoV6")
)

// ServerIpAddress (LPWSTR optional), Flags (DWORD), OptionID (DWORD), ClassName (LPWSTR optional), VendorName (LPWSTR optional), OptionInfo (DHCP_OPTION** in/out)
r1, _, err := procDhcpGetOptionInfoV6.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ServerIpAddress))),
	uintptr(Flags),
	uintptr(OptionID),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ClassName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(VendorName))),
	uintptr(OptionInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function DhcpGetOptionInfoV6(
  ServerIpAddress: PWideChar;   // LPWSTR optional
  Flags: DWORD;   // DWORD
  OptionID: DWORD;   // DWORD
  ClassName: PWideChar;   // LPWSTR optional
  VendorName: PWideChar;   // LPWSTR optional
  OptionInfo: Pointer   // DHCP_OPTION** in/out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpGetOptionInfoV6';

result := DllCall("DHCPSAPI\DhcpGetOptionInfoV6"
    , "WStr", ServerIpAddress   ; LPWSTR optional
    , "UInt", Flags   ; DWORD
    , "UInt", OptionID   ; DWORD
    , "WStr", ClassName   ; LPWSTR optional
    , "WStr", VendorName   ; LPWSTR optional
    , "Ptr", OptionInfo   ; DHCP_OPTION** in/out
    , "UInt")   ; return: DWORD

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