Fonction PxeDhcpGetOptionValue (wdspxe.h)

Récupère une valeur d’option à partir d’un paquet DHCP.

Syntaxe

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

Paramètres

[in] pPacket

Pointeur vers un paquet de réponse alloué avec la fonction PxePacketAllocate .

[in] uPacketLen

Longueur du paquet pointé vers le paramètre pReplyPacket .

[in] uInstance

Index de base unique qui spécifie les instance du paramètre bOption à récupérer.

[in] bOption

Option dont la valeur sera récupérée.

[out, optional] pbOptionLen

Adresse de BYTE qui recevra la longueur de la valeur d’option.

[out, optional] ppOptionValue

Adresse de PVOID qui recevra l’adresse de la valeur d’option à l’intérieur du paquet.

Valeur retournée

Les valeurs de retour courantes sont répertoriées dans le tableau suivant. Pour tous les autres échecs, un code d’erreur Windows approprié est retourné.

Code/valeur de retour	Description
ERROR_SUCCESS 0 (0x0)	L’option a été trouvée et un pointeur vers la valeur a été retourné.
ERROR_FILE_NOT_FOUND 2 (0x2)	L’option n’a pas été trouvée.
ERROR_INVALID_DATA 13 (0xD)	Le paquet n’est pas un paquet DHCP valide. Ce test n’est pas aussi approfondi que les tests utilisés par la fonction PxeDhcpIsValid ; seuls la longueur du paquet et le cookie magique sont vérifiés.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows Server 2008, Windows Server 2003 avec SP2 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	wdspxe.h
Bibliothèque	WdsPxe.lib
DLL	WdsPxe.dll

Voir aussi

PxeDhcpAppendOption

PxeDhcpGetVendorOptionValue

PxePacketAllocate

Fonctions serveur des services de déploiement Windows