Edit

Share via

PxeDhcpv6ParseRelayForw function (wdspxe.h)

  • Article

This function can be used by a provider to parse RELAY-FORW messages and their nested OPTION_RELAY_MSG messages. The information returned can be used to construct a RELAY-REPL packet using the PxeDhcpv6CreateRelayRepl function.

For more information about RELAY-FORW and OPTION_RELAY_MSG messages, developers should refer to the Dynamic Host Configuration Protocol for IPv6 (RFC 3315) maintained by The Internet Engineering Task Force (IETF).

Syntax

DWORD PXEAPI PxeDhcpv6ParseRelayForw(
  [in]  PVOID                            pRelayForwPacket,
  [in]  ULONG                            uRelayForwPacketLen,
  [out] PPXE_DHCPV6_NESTED_RELAY_MESSAGE pRelayMessages,
  [in]  ULONG                            nRelayMessages,
  [out] PULONG                           pnRelayMessages,
  [out] PBYTE                            *ppInnerPacket,
  [out] PULONG                           pcbInnerPacket
);

Parameters

[in] pRelayForwPacket

Specifies a pointer to a DHCPv6 RELAY-FORW message.

[in] uRelayForwPacketLen

The size in bytes of the RELAY-FORW message pointed to by the pRelayForwPacket parameter.

[out] pRelayMessages

An array of PXE_DHCPV6_NESTED_RELAY_MESSAGE structures initialized by this routine. The array’s size is specified by nRelayMessages. Elements of this array are initialized to point to the nested chain of relay packets encoded in OPTION_RELAY_MSG. Index 0 is the outermost nested OPTION_RELAY_MSG packet. As the index increases the pointers correspond to more deeply nested OPTION_RELAY_MSG packets.

[in] nRelayMessages

The size of the array, in number of array elements, pointed to by the pRelayMessages parameter.

[out] pnRelayMessages

Specifies a pointer to a ULONG value which on success receives the actual number of elements written into the pRelayMessages array.

[out] ppInnerPacket

Specifies a pointer to a PVOID value which on success is set to the start of the innermost packet in the relay chain. This is the original client request packet.

[out] pcbInnerPacket

Specifies a pointer to a ULONG value which on success will be set to the size, in bytes, of the innermost packet in the relay chain which is the original client request packet.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

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