PxeDhcpv6IsValid function (wdspxe.h)

Article
10/13/2021

Validates that a packet is a valid DHCPv6 packet.

For more information about valid DHCPv6 packets, developers should refer to the Dynamic Host Configuration Protocol for IPv6 (RFC 3315) maintained by The Internet Engineering Task Force (IETF).

Syntax

DWORD PXEAPI PxeDhcpv6IsValid(
  [in]  PVOID pPacket,
  [in]  ULONG uPacketLen,
  [in]  BOOL  bRequestPacket,
  [out] PBOOL pbPxeOptionPresent
);

Parameters

[in] pPacket

Pointer to a reply packet allocated with the PxePacketAllocate function.

[in] uPacketLen

Length of the packet pointed to by the pPacket parameter.

[in] bRequestPacket

Indicates whether the packet is a request packet. The following table lists the possible values.

Value	Meaning
TRUE 1	Packet to be validated is a request packet from the client.
FALSE 0	Packet to be validated is a packet generated by the server.

[out] pbPxeOptionPresent

Address of a BOOL that is set to TRUE if the packet is a valid DHCPv6 packet.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

Remarks

Providers use this function when the filter set with the PxeProviderSetAttribute function is set to receive all packets to determine if a specified packet is a valid DHCPv6 packet. Providers can also use this function to validate reply packets; typically this is done only for debug or test builds of the provider.

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

Share via