Fonction DhcpSetOptionInfoV5 (dhcpsapi.h)

  • Article

La fonction DhcpSetOptionInfoV5 définit des informations pour une option DHCP spécifique.

Syntaxe

DWORD DhcpSetOptionInfoV5(
  [in] LPWSTR         ServerIpAddress,
  [in] DWORD          Flags,
  [in] DHCP_OPTION_ID OptionID,
  [in] LPWSTR         ClassName,
  [in] LPWSTR         VendorName,
  [in] LPDHCP_OPTION  OptionInfo
);

Paramètres

[in] ServerIpAddress

Chaîne Unicode qui spécifie l’adresse IP ou le nom d’hôte du serveur DHCP.

[in] Flags

Spécifie un indicateur de bits qui indique si l’option est spécifique au fournisseur ou non. Si ce n’est pas le cas, ce paramètre doit être 0.

Valeur Signification
DHCP_FLAGS_OPTION_IS_VENDOR
 Cet indicateur doit être défini si l’option est fournie par un fournisseur.

[in] OptionID

DHCP_OPTION_ID valeur qui spécifie le code d’une option DHCP spécifique.

[in] ClassName

Pointeur vers une chaîne Unicode qui spécifie le nom de classe DHCP de l’option. Ce paramètre est facultatif.

[in] VendorName

Pointeur vers une chaîne Unicode qui spécifie le fournisseur de l’option. Ce paramètre est facultatif et doit avoir la valeur NULL lorsque Flags n’est pas défini sur DHCP_FLAGS_OPTION_IS_VENDOR.

[in] OptionInfo

Pointeur vers une structure DHCP_OPTION qui contient les informations sur l’option spécifiée par OptionID.

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_ACCESS_DENIED
 Cet appel a été effectué par un client qui n’est pas membre du groupe de sécurité « Administrateurs DHCP ».
ERROR_DHCP_JET_ERROR
 Une erreur s’est produite lors de l’accès à la base de données du serveur DHCPv6.
ERROR_DHCP_CLASS_NOT_FOUND
 Le nom de classe fourni est incorrect ou n’existe pas sur le serveur DHCP.

Configuration requise

Condition requise Valeur
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

DhcpGetOptionInfoV5