PxeDhcpAppendOption function (wdspxe.h)

Appends a DHCP option to the reply packet.

Syntax

DWORD PXEAPI PxeDhcpAppendOption(
  [in, out] PVOID  pReplyPacket,
  [in]      ULONG  uMaxReplyPacketLen,
  [in, out] PULONG puReplyPacketLen,
  [in]      BYTE   bOption,
  [in]      BYTE   bOptionLen,
  [in]      PVOID  pValue
);

Parameters

[in, out] pReplyPacket

Pointer to a reply packet allocated with the PxePacketAllocate function.

[in] uMaxReplyPacketLen

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

[in, out] puReplyPacketLen

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

[in] bOption

DHCP option to add to the packet.

[in] bOptionLen

Length of the option value pointed to by the pValue parameter. This parameter is ignored if the bOption parameter is End Option (0xFF) or Pad Option (0x00).

[in] pValue

Address of the buffer that contains the DHCP option value. This parameter is ignored if the bOption parameter is End Option (0xFF) or Pad Option (0x00).

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008, Windows Server 2003 with SP2 [desktop apps only]
Target Platform Windows
Header wdspxe.h
Library WdsPxe.lib
DLL WdsPxe.dll

See also

PxePacketAllocate

Windows Deployment Services Server Functions