DhcpSetOptionValuesV5, fonction (dhcpsapi.h)

Article
08/23/2023

La fonction DhcpSetOptionValuesV5 définit les codes d’option et les valeurs de données associées pour une étendue spécifique définie sur le serveur DHCP. Cette fonction étend les fonctionnalités fournies par DhcpSetOptionValues en permettant à l’appelant de spécifier une classe et/ou un fournisseur pour les options.

Syntaxe

DWORD DhcpSetOptionValuesV5(
  [in] LPWSTR                    ServerIpAddress,
  [in] DWORD                     Flags,
  [in] LPWSTR                    ClassName,
  [in] LPWSTR                    VendorName,
  [in] LPDHCP_OPTION_SCOPE_INFO  ScopeInfo,
  [in] LPDHCP_OPTION_VALUE_ARRAY OptionValues
);

Paramètres

[in] ServerIpAddress

Chaîne Unicode qui spécifie l’adresse IPv4 du serveur DHCP.

[in] Flags

Ce paramètre doit être défini sur 0 et ignoré lors de la réception.

[in] ClassName

Chaîne Unicode qui spécifie la classe DHCP des options. Ce paramètre est facultatif.

[in] VendorName

Chaîne Unicode qui spécifie le fournisseur des options. Si aucune classe de fournisseur n’est spécifiée, la valeur d’option est définie pour la classe fournisseur par défaut. Ce paramètre est facultatif.

[in] ScopeInfo

Pointeur vers une structure DHCP_OPTION_SCOPE_INFO qui contient des informations décrivant l’étendue DHCP sur laquelle ces valeurs d’option seront définies. Ce paramètre indique si la valeur d’option est définie pour le niveau par défaut, serveur ou étendue, ou pour une réservation IPv4.

[in] OptionValues

Pointeur vers une structure de DHCP_OPTION_VALUE_ARRAY qui contient une liste de codes d’option et la valeur de données correspondante qui sera définie pour eux.

Valeur retournée

Cette fonction retourne ERROR_SUCCESS en cas d’appel réussi. Sinon, il retourne l’un des codes d’erreur de l’API gestion du serveur DHCP.

Code de retour	Description
ERROR_DHCP_JET_ERROR	Une erreur s’est produite lors de l’accès à la base de données du serveur DHCP.
ERROR_DHCP_SUBNET_NOT_PRESENT	Le sous-réseau IPv4 spécifié n’existe pas sur le serveur DHCP.
ERROR_DHCP_OPTION_NOT_PRESENT	La définition d’option spécifiée est introuvable dans la base de données du serveur DHCP.
ERROR_DHCP_NOT_RESERVED_CLIENT	Le client DHCP spécifié n’est pas un client réservé IPv4.
ERROR_DHCP_CLASS_NOT_FOUND	Le nom de classe spécifié est introuvable dans la base de données du serveur DHCP.

Notes

L’appelant de cette fonction doit libérer la mémoire pointée par OptionValues une fois l’appel terminé.

Spécifications


Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows Server 2008 R2 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	dhcpsapi.h
Bibliothèque	Dhcpsapi.lib
DLL	Dhcpsapi.dll

Voir aussi

DHCP_OPTION_SCOPE_INFO

DHCP_OPTION_VALUE_ARRAY

DhcpSetOptionValueV5

DhcpSetOptionValues