Win32 API 日本語リファレンス
ホームSystem.DeploymentServices › PxeDhcpGetVendorOptionValue

PxeDhcpGetVendorOptionValue

関数
DHCPパケットから指定ベンダー固有オプションの値を取得する。
DLLWDSPXE.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD PxeDhcpGetVendorOptionValue(
    void* pPacket,
    DWORD uPacketLen,
    BYTE bOption,
    DWORD uInstance,
    BYTE* pbOptionLen,   // optional
    void** ppOptionValue   // optional
);

パラメーター

名前方向
pPacketvoid*in
uPacketLenDWORDin
bOptionBYTEin
uInstanceDWORDin
pbOptionLenBYTE*outoptional
ppOptionValuevoid**outoptional

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD PxeDhcpGetVendorOptionValue(
    void* pPacket,
    DWORD uPacketLen,
    BYTE bOption,
    DWORD uInstance,
    BYTE* pbOptionLen,   // optional
    void** ppOptionValue   // optional
);
[DllImport("WDSPXE.dll", ExactSpelling = true)]
static extern uint PxeDhcpGetVendorOptionValue(
    IntPtr pPacket,   // void*
    uint uPacketLen,   // DWORD
    byte bOption,   // BYTE
    uint uInstance,   // DWORD
    IntPtr pbOptionLen,   // BYTE* optional, out
    IntPtr ppOptionValue   // void** optional, out
);
<DllImport("WDSPXE.dll", ExactSpelling:=True)>
Public Shared Function PxeDhcpGetVendorOptionValue(
    pPacket As IntPtr,   ' void*
    uPacketLen As UInteger,   ' DWORD
    bOption As Byte,   ' BYTE
    uInstance As UInteger,   ' DWORD
    pbOptionLen As IntPtr,   ' BYTE* optional, out
    ppOptionValue As IntPtr   ' void** optional, out
) As UInteger
End Function
' pPacket : void*
' uPacketLen : DWORD
' bOption : BYTE
' uInstance : DWORD
' pbOptionLen : BYTE* optional, out
' ppOptionValue : void** optional, out
Declare PtrSafe Function PxeDhcpGetVendorOptionValue Lib "wdspxe" ( _
    ByVal pPacket As LongPtr, _
    ByVal uPacketLen As Long, _
    ByVal bOption As Byte, _
    ByVal uInstance As Long, _
    ByVal pbOptionLen As LongPtr, _
    ByVal ppOptionValue As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PxeDhcpGetVendorOptionValue = ctypes.windll.wdspxe.PxeDhcpGetVendorOptionValue
PxeDhcpGetVendorOptionValue.restype = wintypes.DWORD
PxeDhcpGetVendorOptionValue.argtypes = [
    ctypes.POINTER(None),  # pPacket : void*
    wintypes.DWORD,  # uPacketLen : DWORD
    ctypes.c_ubyte,  # bOption : BYTE
    wintypes.DWORD,  # uInstance : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbOptionLen : BYTE* optional, out
    ctypes.c_void_p,  # ppOptionValue : void** optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WDSPXE.dll')
PxeDhcpGetVendorOptionValue = Fiddle::Function.new(
  lib['PxeDhcpGetVendorOptionValue'],
  [
    Fiddle::TYPE_VOIDP,  # pPacket : void*
    -Fiddle::TYPE_INT,  # uPacketLen : DWORD
    -Fiddle::TYPE_CHAR,  # bOption : BYTE
    -Fiddle::TYPE_INT,  # uInstance : DWORD
    Fiddle::TYPE_VOIDP,  # pbOptionLen : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # ppOptionValue : void** optional, out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wdspxe")]
extern "system" {
    fn PxeDhcpGetVendorOptionValue(
        pPacket: *mut (),  // void*
        uPacketLen: u32,  // DWORD
        bOption: u8,  // BYTE
        uInstance: u32,  // DWORD
        pbOptionLen: *mut u8,  // BYTE* optional, out
        ppOptionValue: *mut *mut ()  // void** optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WDSPXE.dll")]
public static extern uint PxeDhcpGetVendorOptionValue(IntPtr pPacket, uint uPacketLen, byte bOption, uint uInstance, IntPtr pbOptionLen, IntPtr ppOptionValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WDSPXE_PxeDhcpGetVendorOptionValue' -Namespace Win32 -PassThru
# $api::PxeDhcpGetVendorOptionValue(pPacket, uPacketLen, bOption, uInstance, pbOptionLen, ppOptionValue)
#uselib "WDSPXE.dll"
#func global PxeDhcpGetVendorOptionValue "PxeDhcpGetVendorOptionValue" sptr, sptr, sptr, sptr, sptr, sptr
; PxeDhcpGetVendorOptionValue pPacket, uPacketLen, bOption, uInstance, varptr(pbOptionLen), ppOptionValue   ; 戻り値は stat
; pPacket : void* -> "sptr"
; uPacketLen : DWORD -> "sptr"
; bOption : BYTE -> "sptr"
; uInstance : DWORD -> "sptr"
; pbOptionLen : BYTE* optional, out -> "sptr"
; ppOptionValue : void** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WDSPXE.dll"
#cfunc global PxeDhcpGetVendorOptionValue "PxeDhcpGetVendorOptionValue" sptr, int, int, int, var, sptr
; res = PxeDhcpGetVendorOptionValue(pPacket, uPacketLen, bOption, uInstance, pbOptionLen, ppOptionValue)
; pPacket : void* -> "sptr"
; uPacketLen : DWORD -> "int"
; bOption : BYTE -> "int"
; uInstance : DWORD -> "int"
; pbOptionLen : BYTE* optional, out -> "var"
; ppOptionValue : void** optional, out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD PxeDhcpGetVendorOptionValue(void* pPacket, DWORD uPacketLen, BYTE bOption, DWORD uInstance, BYTE* pbOptionLen, void** ppOptionValue)
#uselib "WDSPXE.dll"
#cfunc global PxeDhcpGetVendorOptionValue "PxeDhcpGetVendorOptionValue" intptr, int, int, int, var, intptr
; res = PxeDhcpGetVendorOptionValue(pPacket, uPacketLen, bOption, uInstance, pbOptionLen, ppOptionValue)
; pPacket : void* -> "intptr"
; uPacketLen : DWORD -> "int"
; bOption : BYTE -> "int"
; uInstance : DWORD -> "int"
; pbOptionLen : BYTE* optional, out -> "var"
; ppOptionValue : void** optional, out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wdspxe = windows.NewLazySystemDLL("WDSPXE.dll")
	procPxeDhcpGetVendorOptionValue = wdspxe.NewProc("PxeDhcpGetVendorOptionValue")
)

// pPacket (void*), uPacketLen (DWORD), bOption (BYTE), uInstance (DWORD), pbOptionLen (BYTE* optional, out), ppOptionValue (void** optional, out)
r1, _, err := procPxeDhcpGetVendorOptionValue.Call(
	uintptr(pPacket),
	uintptr(uPacketLen),
	uintptr(bOption),
	uintptr(uInstance),
	uintptr(pbOptionLen),
	uintptr(ppOptionValue),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function PxeDhcpGetVendorOptionValue(
  pPacket: Pointer;   // void*
  uPacketLen: DWORD;   // DWORD
  bOption: Byte;   // BYTE
  uInstance: DWORD;   // DWORD
  pbOptionLen: Pointer;   // BYTE* optional, out
  ppOptionValue: Pointer   // void** optional, out
): DWORD; stdcall;
  external 'WDSPXE.dll' name 'PxeDhcpGetVendorOptionValue';
result := DllCall("WDSPXE\PxeDhcpGetVendorOptionValue"
    , "Ptr", pPacket   ; void*
    , "UInt", uPacketLen   ; DWORD
    , "UChar", bOption   ; BYTE
    , "UInt", uInstance   ; DWORD
    , "Ptr", pbOptionLen   ; BYTE* optional, out
    , "Ptr", ppOptionValue   ; void** optional, out
    , "UInt")   ; return: DWORD
●PxeDhcpGetVendorOptionValue(pPacket, uPacketLen, bOption, uInstance, pbOptionLen, ppOptionValue) = DLL("WDSPXE.dll", "dword PxeDhcpGetVendorOptionValue(void*, dword, byte, dword, void*, void*)")
# 呼び出し: PxeDhcpGetVendorOptionValue(pPacket, uPacketLen, bOption, uInstance, pbOptionLen, ppOptionValue)
# pPacket : void* -> "void*"
# uPacketLen : DWORD -> "dword"
# bOption : BYTE -> "byte"
# uInstance : DWORD -> "dword"
# pbOptionLen : BYTE* optional, out -> "void*"
# ppOptionValue : void** optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。