DhcpCreateOptionV5, fonction (dhcpsapi.h)

Article
08/23/2023

La fonction DhcpCreateOptionV5 crée une option DHCP.

Syntaxe

DWORD DhcpCreateOptionV5(
  [in]           LPWSTR         ServerIpAddress,
  [in]           DWORD          Flags,
  [in]           DHCP_OPTION_ID OptionId,
  [in, optional] LPWSTR         ClassName,
  [in, optional] 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

Valeur d’indicateur qui indique si l’option concerne une classe de fournisseur spécifique ou par défaut.

Valeur	Signification
0x00000000	La valeur d’option est récupérée pour une classe de fournisseur par défaut.
DHCP_FLAGS_OPTION_IS_VENDOR 0x00000003	La valeur de l’option est récupérée pour une classe de fournisseur spécifique. Le nom du fournisseur est fourni dans VendorName.

[in] OptionId

DHCP_OPTION_ID valeur qui contient le numéro d’ID d’option unique (également appelé « code d’option ») de la nouvelle option. La plupart de ces numéros d’id d’option sont définis ; Vous trouverez la liste complète des codes d’option DHCP et BOOTP standard dans Options DHCP et Extensions de fournisseur BOOTP.

[in, optional] ClassName

Chaîne Unicode qui spécifie le nom de la classe DHCP qui contiendra cette option. Ce champ est facultatif.

[in, optional] VendorName

Chaîne Unicode qui contient une chaîne de nom de fournisseur si la classe spécifiée dans ClassName est une classe propre au fournisseur.

[in] OptionInfo

DHCP_OPTION structure qui contient des informations décrivant la nouvelle option DHCP, y compris le nom, un commentaire facultatif et tous les éléments de données associés.

Valeur retournée

Cette fonction retourne ERROR_SUCCESS en cas d’appel réussi. Sinon, elle 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 DHCP.
ERROR_DHCP_OPTION_EXISTS	La définition d’option spécifiée existe déjà dans la base de données du serveur DHCP.
ERROR_DHCP_CLASS_NOT_FOUND	Le nom de classe spécifié est inconnu ou mal formé.

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

Partager via