PxeDhcpGetOptionValue 函数 (wdspxe.h)

从 DHCP 数据包中检索选项值。

语法

DWORD PXEAPI PxeDhcpGetOptionValue(
  [in]            PVOID pPacket,
  [in]            ULONG uPacketLen,
  [in]            ULONG uInstance,
  [in]            BYTE  bOption,
  [out, optional] PBYTE pbOptionLen,
  [out, optional] PVOID *ppOptionValue
);

参数

[in] pPacket

指向使用 PxePacketAllocate 函数分配的答复数据包的指针。

[in] uPacketLen

pReplyPacket 参数指向的数据包的长度。

[in] uInstance

从 1 开始的索引，指定要检索 的 bOption 参数的实例。

[in] bOption

将检索其值的选项。

[out, optional] pbOptionLen

将接收选项值的长度的 BYTE 的地址。

[out, optional] ppOptionValue

将接收数据包内选项值的地址的 PVOID 的地址。

返回值

下表列出了常见的返回值。 对于所有其他故障，将返回相应的 Windows 错误代码。

返回代码/值	说明
ERROR_SUCCESS 0 (0x0)	找到 选项并返回指向值的指针。
ERROR_FILE_NOT_FOUND 2 (0x2)	未找到选项。
ERROR_INVALID_DATA 13 (0xD)	数据包不是有效的 DHCP 数据包。 此测试不如 PxeDhcpIsValid 函数使用的测试那么全面;仅验证数据包长度和 magic Cookie。

要求

要求	值
最低受支持的客户端	无受支持的版本
最低受支持的服务器	Windows Server 2008、Windows Server 2003 SP2 [仅限桌面应用]
目标平台	Windows
标头	wdspxe.h
Library	WdsPxe.lib
DLL	WdsPxe.dll

另请参阅

PxeDhcpAppendOption

PxeDhcpGetVendorOptionValue

PxePacketAllocate

Windows 部署服务服务器函数