DhcpRemoveOptionV5, fonction (dhcpsapi.h)

  • Article

La fonction DhcpRemoveOptionV5 supprime la définition d’une option spécifique pour une classe d’utilisateur et une classe de fournisseur spécifique au niveau de l’option par défaut sur le serveur DHCP. Cela étend les fonctionnalités de DhcpRemoveOption avec la prise en charge de noms de classes et de fournisseurs spécifiques.

Syntaxe

DWORD DhcpRemoveOptionV5(
  [in] LPWSTR         ServerIpAddress,
  [in] DWORD          Flags,
  [in] DHCP_OPTION_ID OptionID,
  [in] LPWSTR         ClassName,
  [in] LPWSTR         VendorName
);

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. Si ce n’est pas le cas, ce paramètre doit être 0.

Valeur Signification
0x00000000
 Cet indicateur doit être défini si l’option est supprimée pour la classe de fournisseur par défaut.
DHCP_FLAGS_OPTION_IS_VENDOR
0x00000003
 Cet indicateur doit être défini si l’option est supprimée pour une classe de fournisseur spécifique.

[in] OptionID

DHCP_OPTION_ID valeur qui spécifie le code de l’option à supprimer.

[in] ClassName

Chaîne Unicode qui spécifie le nom de la classe DHCP de l’option. Ce paramètre est facultatif.

[in] VendorName

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

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_NOT_PRESENT
 La définition d’option spécifiée n’existe pas dans la base de données du serveur DHCP.
ERROR_DHCP_CLASS_NOT_FOUND
 Le nom de classe fourni est inconnu ou incorrect.

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

DhcpCreateOptionV5