PxeDhcpv6GetVendorOptionValue function (wdspxe.h)
Retrieves option values from the OPTION_VENDOR_OPTS (17) field of a DHCPv6 packet.
Syntax
DWORD PXEAPI PxeDhcpv6GetVendorOptionValue(
[in] PVOID pPacket,
[in] ULONG uPacketLen,
[in] DWORD dwEnterpriseNumber,
[in] WORD wOption,
[in] ULONG uInstance,
[out, optional] PWORD pwOptionLen,
[out, optional] PVOID *ppOptionValue
);
Parameters
[in] pPacket
Pointer to a reply packet allocated with the PxePacketAllocate function.
[in] uPacketLen
Length of the packet pointed to by the pReplyPacket parameter.
[in] dwEnterpriseNumber
An Enterprise Number assigned to the vendor of the option by the Internet Assigned Numbers Authority (IANA).
For more information about assigned Enterprise Numbers, developers should refer to the Dynamic Host Configuration Protocol for IPv6 (RFC 3315) maintained by The Internet Engineering Task Force (IETF).
[in] wOption
Option whose value will be retrieved.
[in] uInstance
One-based index that specifies which instance of the wOption parameter to retrieve.
[out, optional] pwOptionLen
Address of WORD which will receive the length of the option value.
[out, optional] ppOptionValue
Address of PVOID which will receive the address of the option value inside the packet.
Return value
Common return values are listed in the following table. For all other failures, an appropriate Windows error code is returned.
| Return code/value | Description |
|---|---|
|
The option was found and a pointer to the value was returned. |
|
The option was not located. |
|
The packet is not a valid DHCP packet. This test is not as thorough as the tests used by the PxeDhcpv6IsValid function; only the packet length and magic cookie are verified. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 [desktop apps only] |
| Minimum supported server | Windows Server 2012 [desktop apps only] |
| Target Platform | Windows |
| Header | wdspxe.h |
| Library | WdsPxe.lib |
| DLL | WdsPxe.dll |