EN
Ce contenu n’est pas disponible dans votre langue. Voici la version anglaise.

PxeDhcpv6GetOptionValue function

Retrieves an option value from a DHCPv6 packet.

Syntax


DWORD PXEAPI PxeDhcpv6GetOptionValue(
  _In_       PVOID pPacket,
  _In_       ULONG uPacketLen,
  _In_       ULONG uInstance,
  _In_       WORD wOption,
  _Out_opt_  PWORD pwOptionLen,
  _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.

uInstance [in]

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

wOption [in]

Option whose value will be retrieved.

pwOptionLen [out, optional]

Address of WORD 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 DHCPv6 packet. This test is not as thorough as the tests used by the PxeDhcpv6IsValid function; only the packet length and magic cookie are verified.

 

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

WdsPxe.h

Library

WdsPxe.lib

DLL

WdsPxe.dll

See also

Windows Deployment Services Server Functions
PxeDhcpv6AppendOption
PxeDhcpv6GetVendorOptionValue
PxePacketAllocate
PxeDhcpv6IsValid

 

 

Ajouts de la communauté

AJOUTER
Afficher:
© 2014 Microsoft