Edit

Share via

PxeDhcpv6CreateRelayRepl function (wdspxe.h)

  • Article

Generates a RELAY-REPL message.

For more information about RELAY-REPL and RELAY-FORW 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 PxeDhcpv6CreateRelayRepl(
  [in]  PPXE_DHCPV6_NESTED_RELAY_MESSAGE pRelayMessages,
  [in]  ULONG                            nRelayMessages,
  [in]  PBYTE                            pInnerPacket,
  [in]  ULONG                            cbInnerPacket,
  [out] PVOID                            pReplyBuffer,
  [in]  ULONG                            cbReplyBuffer,
  [out] PULONG                           pcbReplyBuffer
);

Parameters

[in] pRelayMessages

An array of PXE_DHCPV6_NESTED_RELAY_FORW structures which together specify the sequence of nested RELAY-FORW packets. This value can be obtained from the pRelayMessages parameter of PxeDhcpv6ParseRelayForw.

[in] nRelayMessages

The number of elements in the array pointed to by the pRelayMessages argument.

[in] pInnerPacket

A pointer to a packet which is the server’s response to the innermost packet in the RELAY-FORW chain.

[in] cbInnerPacket

The size of the packet pointed to by the pInnerPacket argument.

[out] pReplyBuffer

A pointer to a buffer used to construct the outer RELAY-REPL packet. This buffer receives the nested response packet and the nested RELAY-REPL chain specified by the pRelayMessages parameter.

[in] cbReplyBuffer

The size of the buffer in bytes pointed to by pRelyBuffer.

[out] pcbReplyBuffer

On success, this is set to the actual size of the RELAY-REPL packet in the buffer pointed to by pRelyBuffer.

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