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

PxeDhcpGetOptionValue

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

シグネチャ

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

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

パラメーター

名前方向説明
pPacketvoid*inオプションを取得する対象のDHCPパケットへのポインタ。
uPacketLenDWORDinパケットの長さ(バイト単位)。
uInstanceDWORDin同一オプションが複数ある場合の取得インスタンス番号(1始まり)。
bOptionBYTEin取得するDHCPオプションのコード。
pbOptionLenBYTE*outoptional取得したオプション値の長さを受け取るBYTEポインタ。
ppOptionValuevoid**outoptionalパケット内のオプション値先頭を指すポインタを受け取る。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD PxeDhcpGetOptionValue(
    void* pPacket,
    DWORD uPacketLen,
    DWORD uInstance,
    BYTE bOption,
    BYTE* pbOptionLen,   // optional
    void** ppOptionValue   // optional
);
[DllImport("WDSPXE.dll", ExactSpelling = true)]
static extern uint PxeDhcpGetOptionValue(
    IntPtr pPacket,   // void*
    uint uPacketLen,   // DWORD
    uint uInstance,   // DWORD
    byte bOption,   // BYTE
    IntPtr pbOptionLen,   // BYTE* optional, out
    IntPtr ppOptionValue   // void** optional, out
);
<DllImport("WDSPXE.dll", ExactSpelling:=True)>
Public Shared Function PxeDhcpGetOptionValue(
    pPacket As IntPtr,   ' void*
    uPacketLen As UInteger,   ' DWORD
    uInstance As UInteger,   ' DWORD
    bOption As Byte,   ' BYTE
    pbOptionLen As IntPtr,   ' BYTE* optional, out
    ppOptionValue As IntPtr   ' void** optional, out
) As UInteger
End Function
' pPacket : void*
' uPacketLen : DWORD
' uInstance : DWORD
' bOption : BYTE
' pbOptionLen : BYTE* optional, out
' ppOptionValue : void** optional, out
Declare PtrSafe Function PxeDhcpGetOptionValue Lib "wdspxe" ( _
    ByVal pPacket As LongPtr, _
    ByVal uPacketLen As Long, _
    ByVal uInstance As Long, _
    ByVal bOption As Byte, _
    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

PxeDhcpGetOptionValue = ctypes.windll.wdspxe.PxeDhcpGetOptionValue
PxeDhcpGetOptionValue.restype = wintypes.DWORD
PxeDhcpGetOptionValue.argtypes = [
    ctypes.POINTER(None),  # pPacket : void*
    wintypes.DWORD,  # uPacketLen : DWORD
    wintypes.DWORD,  # uInstance : DWORD
    ctypes.c_ubyte,  # bOption : BYTE
    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')
PxeDhcpGetOptionValue = Fiddle::Function.new(
  lib['PxeDhcpGetOptionValue'],
  [
    Fiddle::TYPE_VOIDP,  # pPacket : void*
    -Fiddle::TYPE_INT,  # uPacketLen : DWORD
    -Fiddle::TYPE_INT,  # uInstance : DWORD
    -Fiddle::TYPE_CHAR,  # bOption : BYTE
    Fiddle::TYPE_VOIDP,  # pbOptionLen : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # ppOptionValue : void** optional, out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wdspxe")]
extern "system" {
    fn PxeDhcpGetOptionValue(
        pPacket: *mut (),  // void*
        uPacketLen: u32,  // DWORD
        uInstance: u32,  // DWORD
        bOption: u8,  // BYTE
        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 PxeDhcpGetOptionValue(IntPtr pPacket, uint uPacketLen, uint uInstance, byte bOption, IntPtr pbOptionLen, IntPtr ppOptionValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WDSPXE_PxeDhcpGetOptionValue' -Namespace Win32 -PassThru
# $api::PxeDhcpGetOptionValue(pPacket, uPacketLen, uInstance, bOption, pbOptionLen, ppOptionValue)
#uselib "WDSPXE.dll"
#func global PxeDhcpGetOptionValue "PxeDhcpGetOptionValue" sptr, sptr, sptr, sptr, sptr, sptr
; PxeDhcpGetOptionValue pPacket, uPacketLen, uInstance, bOption, varptr(pbOptionLen), ppOptionValue   ; 戻り値は stat
; pPacket : void* -> "sptr"
; uPacketLen : DWORD -> "sptr"
; uInstance : DWORD -> "sptr"
; bOption : BYTE -> "sptr"
; pbOptionLen : BYTE* optional, out -> "sptr"
; ppOptionValue : void** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WDSPXE.dll"
#cfunc global PxeDhcpGetOptionValue "PxeDhcpGetOptionValue" sptr, int, int, int, var, sptr
; res = PxeDhcpGetOptionValue(pPacket, uPacketLen, uInstance, bOption, pbOptionLen, ppOptionValue)
; pPacket : void* -> "sptr"
; uPacketLen : DWORD -> "int"
; uInstance : DWORD -> "int"
; bOption : BYTE -> "int"
; pbOptionLen : BYTE* optional, out -> "var"
; ppOptionValue : void** optional, out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD PxeDhcpGetOptionValue(void* pPacket, DWORD uPacketLen, DWORD uInstance, BYTE bOption, BYTE* pbOptionLen, void** ppOptionValue)
#uselib "WDSPXE.dll"
#cfunc global PxeDhcpGetOptionValue "PxeDhcpGetOptionValue" intptr, int, int, int, var, intptr
; res = PxeDhcpGetOptionValue(pPacket, uPacketLen, uInstance, bOption, pbOptionLen, ppOptionValue)
; pPacket : void* -> "intptr"
; uPacketLen : DWORD -> "int"
; uInstance : DWORD -> "int"
; bOption : BYTE -> "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")
	procPxeDhcpGetOptionValue = wdspxe.NewProc("PxeDhcpGetOptionValue")
)

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

extern "wdspxe" fn PxeDhcpGetOptionValue(
    pPacket: ?*anyopaque, // void*
    uPacketLen: u32, // DWORD
    uInstance: u32, // DWORD
    bOption: u8, // BYTE
    pbOptionLen: [*c]u8, // BYTE* optional, out
    ppOptionValue: ?*anyopaque // void** optional, out
) callconv(std.os.windows.WINAPI) u32;
proc PxeDhcpGetOptionValue(
    pPacket: pointer,  # void*
    uPacketLen: uint32,  # DWORD
    uInstance: uint32,  # DWORD
    bOption: uint8,  # BYTE
    pbOptionLen: ptr uint8,  # BYTE* optional, out
    ppOptionValue: pointer  # void** optional, out
): uint32 {.importc: "PxeDhcpGetOptionValue", stdcall, dynlib: "WDSPXE.dll".}
pragma(lib, "wdspxe");
extern(Windows)
uint PxeDhcpGetOptionValue(
    void* pPacket,   // void*
    uint uPacketLen,   // DWORD
    uint uInstance,   // DWORD
    ubyte bOption,   // BYTE
    ubyte* pbOptionLen,   // BYTE* optional, out
    void** ppOptionValue   // void** optional, out
);
ccall((:PxeDhcpGetOptionValue, "WDSPXE.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, UInt32, UInt8, Ptr{UInt8}, Ptr{Cvoid}),
      pPacket, uPacketLen, uInstance, bOption, pbOptionLen, ppOptionValue)
# pPacket : void* -> Ptr{Cvoid}
# uPacketLen : DWORD -> UInt32
# uInstance : DWORD -> UInt32
# bOption : BYTE -> UInt8
# pbOptionLen : BYTE* optional, out -> Ptr{UInt8}
# ppOptionValue : void** optional, out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PxeDhcpGetOptionValue(
    void* pPacket,
    uint32_t uPacketLen,
    uint32_t uInstance,
    uint8_t bOption,
    uint8_t* pbOptionLen,
    void** ppOptionValue);
]]
local wdspxe = ffi.load("wdspxe")
-- wdspxe.PxeDhcpGetOptionValue(pPacket, uPacketLen, uInstance, bOption, pbOptionLen, ppOptionValue)
-- pPacket : void*
-- uPacketLen : DWORD
-- uInstance : DWORD
-- bOption : BYTE
-- pbOptionLen : BYTE* optional, out
-- ppOptionValue : void** optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WDSPXE.dll');
const PxeDhcpGetOptionValue = lib.func('__stdcall', 'PxeDhcpGetOptionValue', 'uint32_t', ['void *', 'uint32_t', 'uint32_t', 'uint8_t', 'uint8_t *', 'void *']);
// PxeDhcpGetOptionValue(pPacket, uPacketLen, uInstance, bOption, pbOptionLen, ppOptionValue)
// pPacket : void* -> 'void *'
// uPacketLen : DWORD -> 'uint32_t'
// uInstance : DWORD -> 'uint32_t'
// bOption : BYTE -> 'uint8_t'
// pbOptionLen : BYTE* optional, out -> 'uint8_t *'
// ppOptionValue : void** optional, out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WDSPXE.dll", {
  PxeDhcpGetOptionValue: { parameters: ["pointer", "u32", "u32", "u8", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.PxeDhcpGetOptionValue(pPacket, uPacketLen, uInstance, bOption, pbOptionLen, ppOptionValue)
// pPacket : void* -> "pointer"
// uPacketLen : DWORD -> "u32"
// uInstance : DWORD -> "u32"
// bOption : BYTE -> "u8"
// pbOptionLen : BYTE* optional, out -> "pointer"
// ppOptionValue : void** optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PxeDhcpGetOptionValue(
    void* pPacket,
    uint32_t uPacketLen,
    uint32_t uInstance,
    uint8_t bOption,
    uint8_t* pbOptionLen,
    void** ppOptionValue);
C, "WDSPXE.dll");
// $ffi->PxeDhcpGetOptionValue(pPacket, uPacketLen, uInstance, bOption, pbOptionLen, ppOptionValue);
// pPacket : void*
// uPacketLen : DWORD
// uInstance : DWORD
// bOption : BYTE
// pbOptionLen : BYTE* optional, out
// ppOptionValue : void** optional, out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Wdspxe extends StdCallLibrary {
    Wdspxe INSTANCE = Native.load("wdspxe", Wdspxe.class);
    int PxeDhcpGetOptionValue(
        Pointer pPacket,   // void*
        int uPacketLen,   // DWORD
        int uInstance,   // DWORD
        byte bOption,   // BYTE
        byte[] pbOptionLen,   // BYTE* optional, out
        Pointer ppOptionValue   // void** optional, out
    );
}
@[Link("wdspxe")]
lib LibWDSPXE
  fun PxeDhcpGetOptionValue = PxeDhcpGetOptionValue(
    pPacket : Void*,   # void*
    uPacketLen : UInt32,   # DWORD
    uInstance : UInt32,   # DWORD
    bOption : UInt8,   # BYTE
    pbOptionLen : UInt8*,   # BYTE* optional, out
    ppOptionValue : Void**   # void** optional, out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PxeDhcpGetOptionValueNative = Uint32 Function(Pointer<Void>, Uint32, Uint32, Uint8, Pointer<Uint8>, Pointer<Void>);
typedef PxeDhcpGetOptionValueDart = int Function(Pointer<Void>, int, int, int, Pointer<Uint8>, Pointer<Void>);
final PxeDhcpGetOptionValue = DynamicLibrary.open('WDSPXE.dll')
    .lookupFunction<PxeDhcpGetOptionValueNative, PxeDhcpGetOptionValueDart>('PxeDhcpGetOptionValue');
// pPacket : void* -> Pointer<Void>
// uPacketLen : DWORD -> Uint32
// uInstance : DWORD -> Uint32
// bOption : BYTE -> Uint8
// pbOptionLen : BYTE* optional, out -> Pointer<Uint8>
// ppOptionValue : void** optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PxeDhcpGetOptionValue(
  pPacket: Pointer;   // void*
  uPacketLen: DWORD;   // DWORD
  uInstance: DWORD;   // DWORD
  bOption: Byte;   // BYTE
  pbOptionLen: Pointer;   // BYTE* optional, out
  ppOptionValue: Pointer   // void** optional, out
): DWORD; stdcall;
  external 'WDSPXE.dll' name 'PxeDhcpGetOptionValue';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PxeDhcpGetOptionValue"
  c_PxeDhcpGetOptionValue :: Ptr () -> Word32 -> Word32 -> Word8 -> Ptr Word8 -> Ptr () -> IO Word32
-- pPacket : void* -> Ptr ()
-- uPacketLen : DWORD -> Word32
-- uInstance : DWORD -> Word32
-- bOption : BYTE -> Word8
-- pbOptionLen : BYTE* optional, out -> Ptr Word8
-- ppOptionValue : void** optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pxedhcpgetoptionvalue =
  foreign "PxeDhcpGetOptionValue"
    ((ptr void) @-> uint32_t @-> uint32_t @-> uint8_t @-> (ptr uint8_t) @-> (ptr void) @-> returning uint32_t)
(* pPacket : void* -> (ptr void) *)
(* uPacketLen : DWORD -> uint32_t *)
(* uInstance : DWORD -> uint32_t *)
(* bOption : BYTE -> uint8_t *)
(* pbOptionLen : BYTE* optional, out -> (ptr uint8_t) *)
(* ppOptionValue : void** optional, out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wdspxe (t "WDSPXE.dll"))
(cffi:use-foreign-library wdspxe)

(cffi:defcfun ("PxeDhcpGetOptionValue" pxe-dhcp-get-option-value :convention :stdcall) :uint32
  (p-packet :pointer)   ; void*
  (u-packet-len :uint32)   ; DWORD
  (u-instance :uint32)   ; DWORD
  (b-option :uint8)   ; BYTE
  (pb-option-len :pointer)   ; BYTE* optional, out
  (pp-option-value :pointer))   ; void** optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PxeDhcpGetOptionValue = Win32::API::More->new('WDSPXE',
    'DWORD PxeDhcpGetOptionValue(LPVOID pPacket, DWORD uPacketLen, DWORD uInstance, BYTE bOption, LPVOID pbOptionLen, LPVOID ppOptionValue)');
# my $ret = $PxeDhcpGetOptionValue->Call($pPacket, $uPacketLen, $uInstance, $bOption, $pbOptionLen, $ppOptionValue);
# pPacket : void* -> LPVOID
# uPacketLen : DWORD -> DWORD
# uInstance : DWORD -> DWORD
# bOption : BYTE -> BYTE
# pbOptionLen : BYTE* optional, out -> LPVOID
# ppOptionValue : void** optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。