DhcpRemoveOptionValue, fonction (dhcpsapi.h)

  • Article

La fonction DhcpRemoveOptionValue supprime la valeur d’option d’une option spécifique sur le serveur DHCP4 pour la classe d’utilisateur et la classe de fournisseur par défaut, pour l’étendue spécifiée.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpRemoveOptionValue(
  [in] DHCP_CONST WCHAR                  *ServerIpAddress,
  [in] DHCP_OPTION_ID                    OptionID,
  [in] DHCP_CONST DHCP_OPTION_SCOPE_INFO *ScopeInfo
);

Paramètres

[in] ServerIpAddress

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

[in] OptionID

DHCP_OPTION_ID valeur qui contient le code identifiant de manière unique l’option spécifique à supprimer du serveur DHCP.

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO structure qui contient des informations décrivant l’étendue spécifique (par défaut, serveur, étendue ou niveau de réservation IPv4) à partir de laquelle supprimer la valeur d’option.

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_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 est introuvable dans la base de données du serveur DHCP.
ERROR_DHCP_SUBNET_NOT_PRESENT
 Le sous-réseau IPv4 spécifié n’est pas défini sur le serveur DHCP.
ERROR_DHCP_NOT_RESERVED_CLIENT
 Le client DHCP spécifié n’est pas un client réservé.

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_SCOPE_INFO

DhcpRemoveOptionValueV5

DhcpSetOptionValue