Fonction DhcpCreateOptionV6 (dhcpsapi.h)

  • Article

La fonction DhcpCreateOptionV6 crée une option DHCP.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpCreateOptionV6(
  [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

Pointeur vers une 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 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 à l’adresse http://www.ietf.org/rfc/rfc3315.txt.

[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 spécifique 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, il retourne l’un des codes d’erreur de l’API gestion du serveur DHCP.

Code de retour Description
ERROR_INVALID_PARAMETER
 Les paramètres n’étaient pas valides.
ERROR_DUPLICATE_TAG
 L’étendue spécifiée existe déjà.
ERROR_FILE_NOT_FOUND
 Le nom du fournisseur n’est pas valide. En règle générale, cela est dû au fait que le nom du fournisseur est plus long que 255 caractères.

Spécifications

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