PxeDhcpv6Initialize function (wdspxe.h)

Initializes a response packet as a DHCPv6 reply packet.

For RELAY-FORW messages, this function initializes the message type, hop count, link address and peer address. For other DHCPv6 request types, this function initializes the message type and transaction ID. In all cases, the option payload of the produced packet will be empty.

For more information about 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 PxeDhcpv6Initialize(
  [in]      PVOID  pRequest,
  [in]      ULONG  cbRequest,
  [in, out] PVOID  pReply,
  [in]      ULONG  cbReply,
  [out]     PULONG pcbReplyUsed
);

Parameters

[in] pRequest

Address of a valid DHCPv6 packet received from the client in the PxeProviderRecvRequest callback.

[in] cbRequest

Length of the packet pointed to by the pRequest parameter.

[in, out] pReply

Pointer to a reply packet allocated with the PxePacketAllocate function.

[in] cbReply

Allocated length of the packet pointed to by the pReply parameter.

[out] pcbReplyUsed

Address of a ULONG that on successful completion will receive the length of the packet pointed to by the pReply parameter.

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