Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

PxeDhcpGetVendorOptionValue function

Retrieves an option value from the Vendor Specific Information field (43) of a DHCP packet.

Syntax


DWORD PXEAPI PxeDhcpGetVendorOptionValue(
  _In_      PVOID pPacket,
  _In_      ULONG uPacketLen,
  _In_      BYTE  bOption,
  _In_      ULONG uInstance,
  _Out_opt_ PBYTE pbOptionLen,
  _Out_opt_ PVOID *ppOptionValue
);

Parameters

pPacket [in]

Pointer to a reply packet allocated with the PxePacketAllocate function.

uPacketLen [in]

Length of the packet pointed to by the pReplyPacket parameter.

bOption [in]

Option whose value will be retrieved.

uInstance [in]

One-based index that specifies which instance of the bOption parameter to retrieve.

pbOptionLen [out, optional]

Address of BYTE which will receive the length of the option value.

ppOptionValue [out, optional]

Address of PVOID which will receive the address of the option value inside the packet.

Return value

Common return values are listed in the following table. For all other failures, an appropriate Windows error code is returned.

Return code/valueDescription
ERROR_SUCCESS
0 (0x0)

The option was found and a pointer to the value was returned.

ERROR_FILE_NOT_FOUND
2 (0x2)

The option was not located.

ERROR_INVALID_DATA
13 (0xD)

The packet is not a valid DHCP packet. This test is not as thorough as the tests used by the PxeDhcpIsValid function; only the packet length and magic cookie are verified.

 

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008, Windows Server 2003 with SP2 [desktop apps only]

Header

WdsPxe.h

Library

WdsPxe.lib

DLL

WdsPxe.dll

See also

Windows Deployment Services Server Functions
PxeDhcpGetOptionValue
PxePacketAllocate

 

 

Community Additions

ADD
Show:
© 2015 Microsoft