ホーム › System.DeploymentServices › PxeDhcpv6GetVendorOptionValue

PxeDhcpv6GetVendorOptionValue

関数

DHCPv6パケットから指定ベンダー固有オプションの値を取得する。

DLLWDSPXE.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD PxeDhcpv6GetVendorOptionValue(
    void* pPacket,
    DWORD uPacketLen,
    DWORD dwEnterpriseNumber,
    WORD wOption,
    DWORD uInstance,
    WORD* pwOptionLen,   // optional
    void** ppOptionValue   // optional
);

パラメーター

名前	型	方向	説明
pPacket	void*	in	`<a href="/windows/desktop/api/wdspxe/nf-wdspxe-pxepacketallocate">PxePacketAllocate</a> 関数で割り当てた応答パケットへのポインター。`
uPacketLen	DWORD	in	pReplyPacket パラメーターが指すパケットの長さ。
dwEnterpriseNumber	DWORD	in	Internet Assigned Numbers Authority (IANA) によって、そのオプションのベンダーに割り当てられた Enterprise Number。割り当て済みの Enterprise Number の詳細については、The Internet Engineering Task Force (IETF) が管理する Dynamic Host Configuration Protocol for IPv6 (RFC 3315) を参照してください。
wOption	WORD	in	値を取得する対象のオプション。
uInstance	DWORD	in	wOption パラメーターの何番目のインスタンスを取得するかを指定する、1 から始まるインデックス。
pwOptionLen	WORD*	outoptional	オプション値の長さを受け取る WORD のアドレス。
ppOptionValue	void**	outoptional	パケット内のオプション値のアドレスを受け取る PVOID のアドレス。

戻り値の型: DWORD

公式ドキュメント

DHCPv6 パケットの OPTION_VENDOR_OPTS (17) フィールドからオプションの値を取得します。

戻り値

一般的な戻り値を次の表に示します。それ以外の失敗の場合は、対応する Windows エラーコードが返されます。

戻り値/値	説明
ERROR_SUCCESS 0 (0x0)	オプションが見つかり、その値へのポインターが返されました。
ERROR_FILE_NOT_FOUND 2 (0x2)	オプションが見つかりませんでした。
ERROR_INVALID_DATA 13 (0xD)	パケットが有効な DHCP パケットではありません。この検査は PxeDhcpv6IsValid 関数で行われる検査ほど厳密ではなく、パケット長とマジッククッキーのみが検証されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD PxeDhcpv6GetVendorOptionValue(
    void* pPacket,
    DWORD uPacketLen,
    DWORD dwEnterpriseNumber,
    WORD wOption,
    DWORD uInstance,
    WORD* pwOptionLen,   // optional
    void** ppOptionValue   // optional
);

[DllImport("WDSPXE.dll", ExactSpelling = true)]
static extern uint PxeDhcpv6GetVendorOptionValue(
    IntPtr pPacket,   // void*
    uint uPacketLen,   // DWORD
    uint dwEnterpriseNumber,   // DWORD
    ushort wOption,   // WORD
    uint uInstance,   // DWORD
    IntPtr pwOptionLen,   // WORD* optional, out
    IntPtr ppOptionValue   // void** optional, out
);

<DllImport("WDSPXE.dll", ExactSpelling:=True)>
Public Shared Function PxeDhcpv6GetVendorOptionValue(
    pPacket As IntPtr,   ' void*
    uPacketLen As UInteger,   ' DWORD
    dwEnterpriseNumber As UInteger,   ' DWORD
    wOption As UShort,   ' WORD
    uInstance As UInteger,   ' DWORD
    pwOptionLen As IntPtr,   ' WORD* optional, out
    ppOptionValue As IntPtr   ' void** optional, out
) As UInteger
End Function

' pPacket : void*
' uPacketLen : DWORD
' dwEnterpriseNumber : DWORD
' wOption : WORD
' uInstance : DWORD
' pwOptionLen : WORD* optional, out
' ppOptionValue : void** optional, out
Declare PtrSafe Function PxeDhcpv6GetVendorOptionValue Lib "wdspxe" ( _
    ByVal pPacket As LongPtr, _
    ByVal uPacketLen As Long, _
    ByVal dwEnterpriseNumber As Long, _
    ByVal wOption As Integer, _
    ByVal uInstance As Long, _
    ByVal pwOptionLen 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

PxeDhcpv6GetVendorOptionValue = ctypes.windll.wdspxe.PxeDhcpv6GetVendorOptionValue
PxeDhcpv6GetVendorOptionValue.restype = wintypes.DWORD
PxeDhcpv6GetVendorOptionValue.argtypes = [
    ctypes.POINTER(None),  # pPacket : void*
    wintypes.DWORD,  # uPacketLen : DWORD
    wintypes.DWORD,  # dwEnterpriseNumber : DWORD
    ctypes.c_ushort,  # wOption : WORD
    wintypes.DWORD,  # uInstance : DWORD
    ctypes.POINTER(ctypes.c_ushort),  # pwOptionLen : WORD* optional, out
    ctypes.c_void_p,  # ppOptionValue : void** optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WDSPXE.dll')
PxeDhcpv6GetVendorOptionValue = Fiddle::Function.new(
  lib['PxeDhcpv6GetVendorOptionValue'],
  [
    Fiddle::TYPE_VOIDP,  # pPacket : void*
    -Fiddle::TYPE_INT,  # uPacketLen : DWORD
    -Fiddle::TYPE_INT,  # dwEnterpriseNumber : DWORD
    -Fiddle::TYPE_SHORT,  # wOption : WORD
    -Fiddle::TYPE_INT,  # uInstance : DWORD
    Fiddle::TYPE_VOIDP,  # pwOptionLen : WORD* optional, out
    Fiddle::TYPE_VOIDP,  # ppOptionValue : void** optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "wdspxe")]
extern "system" {
    fn PxeDhcpv6GetVendorOptionValue(
        pPacket: *mut (),  // void*
        uPacketLen: u32,  // DWORD
        dwEnterpriseNumber: u32,  // DWORD
        wOption: u16,  // WORD
        uInstance: u32,  // DWORD
        pwOptionLen: *mut u16,  // WORD* 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 PxeDhcpv6GetVendorOptionValue(IntPtr pPacket, uint uPacketLen, uint dwEnterpriseNumber, ushort wOption, uint uInstance, IntPtr pwOptionLen, IntPtr ppOptionValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WDSPXE_PxeDhcpv6GetVendorOptionValue' -Namespace Win32 -PassThru
# $api::PxeDhcpv6GetVendorOptionValue(pPacket, uPacketLen, dwEnterpriseNumber, wOption, uInstance, pwOptionLen, ppOptionValue)

#uselib "WDSPXE.dll"
#func global PxeDhcpv6GetVendorOptionValue "PxeDhcpv6GetVendorOptionValue" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; PxeDhcpv6GetVendorOptionValue pPacket, uPacketLen, dwEnterpriseNumber, wOption, uInstance, varptr(pwOptionLen), ppOptionValue   ; 戻り値は stat
; pPacket : void* -> "sptr"
; uPacketLen : DWORD -> "sptr"
; dwEnterpriseNumber : DWORD -> "sptr"
; wOption : WORD -> "sptr"
; uInstance : DWORD -> "sptr"
; pwOptionLen : WORD* optional, out -> "sptr"
; ppOptionValue : void** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WDSPXE.dll"
#cfunc global PxeDhcpv6GetVendorOptionValue "PxeDhcpv6GetVendorOptionValue" sptr, int, int, int, int, var, sptr
; res = PxeDhcpv6GetVendorOptionValue(pPacket, uPacketLen, dwEnterpriseNumber, wOption, uInstance, pwOptionLen, ppOptionValue)
; pPacket : void* -> "sptr"
; uPacketLen : DWORD -> "int"
; dwEnterpriseNumber : DWORD -> "int"
; wOption : WORD -> "int"
; uInstance : DWORD -> "int"
; pwOptionLen : WORD* optional, out -> "var"
; ppOptionValue : void** optional, out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WDSPXE.dll"
#cfunc global PxeDhcpv6GetVendorOptionValue "PxeDhcpv6GetVendorOptionValue" sptr, int, int, int, int, sptr, sptr
; res = PxeDhcpv6GetVendorOptionValue(pPacket, uPacketLen, dwEnterpriseNumber, wOption, uInstance, varptr(pwOptionLen), ppOptionValue)
; pPacket : void* -> "sptr"
; uPacketLen : DWORD -> "int"
; dwEnterpriseNumber : DWORD -> "int"
; wOption : WORD -> "int"
; uInstance : DWORD -> "int"
; pwOptionLen : WORD* optional, out -> "sptr"
; ppOptionValue : void** optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。