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

PxeDhcpIsValid

関数
DHCPパケットが有効かおよびPXEオプションの有無を判定する。
DLLWDSPXE.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD PxeDhcpIsValid(
    void* pPacket,
    DWORD uPacketLen,
    BOOL bRequestPacket,
    BOOL* pbPxeOptionPresent   // optional
);

パラメーター

名前方向説明
pPacketvoid*in検証対象のDHCPパケットへのポインタ。
uPacketLenDWORDinパケットの長さ(バイト単位)。
bRequestPacketBOOLinTRUEなら要求パケット、FALSEなら応答パケットとして検証する。
pbPxeOptionPresentBOOL*outoptionalPXE関連オプションの有無を受け取るBOOLポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

PxeDhcpIsValid = ctypes.windll.wdspxe.PxeDhcpIsValid
PxeDhcpIsValid.restype = wintypes.DWORD
PxeDhcpIsValid.argtypes = [
    ctypes.POINTER(None),  # pPacket : void*
    wintypes.DWORD,  # uPacketLen : DWORD
    wintypes.BOOL,  # bRequestPacket : BOOL
    ctypes.c_void_p,  # pbPxeOptionPresent : BOOL* optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wdspxe = windows.NewLazySystemDLL("WDSPXE.dll")
	procPxeDhcpIsValid = wdspxe.NewProc("PxeDhcpIsValid")
)

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

extern "wdspxe" fn PxeDhcpIsValid(
    pPacket: ?*anyopaque, // void*
    uPacketLen: u32, // DWORD
    bRequestPacket: i32, // BOOL
    pbPxeOptionPresent: [*c]i32 // BOOL* optional, out
) callconv(std.os.windows.WINAPI) u32;
proc PxeDhcpIsValid(
    pPacket: pointer,  # void*
    uPacketLen: uint32,  # DWORD
    bRequestPacket: int32,  # BOOL
    pbPxeOptionPresent: ptr int32  # BOOL* optional, out
): uint32 {.importc: "PxeDhcpIsValid", stdcall, dynlib: "WDSPXE.dll".}
pragma(lib, "wdspxe");
extern(Windows)
uint PxeDhcpIsValid(
    void* pPacket,   // void*
    uint uPacketLen,   // DWORD
    int bRequestPacket,   // BOOL
    int* pbPxeOptionPresent   // BOOL* optional, out
);
ccall((:PxeDhcpIsValid, "WDSPXE.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, Int32, Ptr{Int32}),
      pPacket, uPacketLen, bRequestPacket, pbPxeOptionPresent)
# pPacket : void* -> Ptr{Cvoid}
# uPacketLen : DWORD -> UInt32
# bRequestPacket : BOOL -> Int32
# pbPxeOptionPresent : BOOL* optional, out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PxeDhcpIsValid(
    void* pPacket,
    uint32_t uPacketLen,
    int32_t bRequestPacket,
    int32_t* pbPxeOptionPresent);
]]
local wdspxe = ffi.load("wdspxe")
-- wdspxe.PxeDhcpIsValid(pPacket, uPacketLen, bRequestPacket, pbPxeOptionPresent)
-- pPacket : void*
-- uPacketLen : DWORD
-- bRequestPacket : BOOL
-- pbPxeOptionPresent : BOOL* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WDSPXE.dll');
const PxeDhcpIsValid = lib.func('__stdcall', 'PxeDhcpIsValid', 'uint32_t', ['void *', 'uint32_t', 'int32_t', 'int32_t *']);
// PxeDhcpIsValid(pPacket, uPacketLen, bRequestPacket, pbPxeOptionPresent)
// pPacket : void* -> 'void *'
// uPacketLen : DWORD -> 'uint32_t'
// bRequestPacket : BOOL -> 'int32_t'
// pbPxeOptionPresent : BOOL* optional, out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WDSPXE.dll", {
  PxeDhcpIsValid: { parameters: ["pointer", "u32", "i32", "pointer"], result: "u32" },
});
// lib.symbols.PxeDhcpIsValid(pPacket, uPacketLen, bRequestPacket, pbPxeOptionPresent)
// pPacket : void* -> "pointer"
// uPacketLen : DWORD -> "u32"
// bRequestPacket : BOOL -> "i32"
// pbPxeOptionPresent : BOOL* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PxeDhcpIsValid(
    void* pPacket,
    uint32_t uPacketLen,
    int32_t bRequestPacket,
    int32_t* pbPxeOptionPresent);
C, "WDSPXE.dll");
// $ffi->PxeDhcpIsValid(pPacket, uPacketLen, bRequestPacket, pbPxeOptionPresent);
// pPacket : void*
// uPacketLen : DWORD
// bRequestPacket : BOOL
// pbPxeOptionPresent : BOOL* 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 PxeDhcpIsValid(
        Pointer pPacket,   // void*
        int uPacketLen,   // DWORD
        boolean bRequestPacket,   // BOOL
        IntByReference pbPxeOptionPresent   // BOOL* optional, out
    );
}
@[Link("wdspxe")]
lib LibWDSPXE
  fun PxeDhcpIsValid = PxeDhcpIsValid(
    pPacket : Void*,   # void*
    uPacketLen : UInt32,   # DWORD
    bRequestPacket : Int32,   # BOOL
    pbPxeOptionPresent : Int32*   # BOOL* 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 PxeDhcpIsValidNative = Uint32 Function(Pointer<Void>, Uint32, Int32, Pointer<Int32>);
typedef PxeDhcpIsValidDart = int Function(Pointer<Void>, int, int, Pointer<Int32>);
final PxeDhcpIsValid = DynamicLibrary.open('WDSPXE.dll')
    .lookupFunction<PxeDhcpIsValidNative, PxeDhcpIsValidDart>('PxeDhcpIsValid');
// pPacket : void* -> Pointer<Void>
// uPacketLen : DWORD -> Uint32
// bRequestPacket : BOOL -> Int32
// pbPxeOptionPresent : BOOL* optional, out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PxeDhcpIsValid(
  pPacket: Pointer;   // void*
  uPacketLen: DWORD;   // DWORD
  bRequestPacket: BOOL;   // BOOL
  pbPxeOptionPresent: Pointer   // BOOL* optional, out
): DWORD; stdcall;
  external 'WDSPXE.dll' name 'PxeDhcpIsValid';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PxeDhcpIsValid"
  c_PxeDhcpIsValid :: Ptr () -> Word32 -> CInt -> Ptr CInt -> IO Word32
-- pPacket : void* -> Ptr ()
-- uPacketLen : DWORD -> Word32
-- bRequestPacket : BOOL -> CInt
-- pbPxeOptionPresent : BOOL* optional, out -> Ptr CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pxedhcpisvalid =
  foreign "PxeDhcpIsValid"
    ((ptr void) @-> uint32_t @-> int32_t @-> (ptr int32_t) @-> returning uint32_t)
(* pPacket : void* -> (ptr void) *)
(* uPacketLen : DWORD -> uint32_t *)
(* bRequestPacket : BOOL -> int32_t *)
(* pbPxeOptionPresent : BOOL* optional, out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wdspxe (t "WDSPXE.dll"))
(cffi:use-foreign-library wdspxe)

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