DhcpSetOptionValue, fonction (dhcpsapi.h)

  • Article

La fonction DhcpSetOptionValue définit des informations pour une valeur d’option spécifique sur le serveur DHCP.

Syntaxe

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

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] OptionID

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

[in] ScopeInfo

Pointeur vers une structure DHCP_OPTION_SCOPE_INFO qui contient des informations décrivant le niveau (par défaut, serveur, étendue ou réservation IPv4) auquel cette valeur d’option sera définie.

[in] OptionValue

Pointeur vers une structure DHCP_OPTION_DATA qui contient la valeur de données correspondant au code d’option DHCP spécifié par OptionID.

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’existe pas sur le serveur DHCP.
ERROR_DHCP_NOT_RESERVED_CLIENT
 Le client DHCP spécifié n’est pas un client réservé.
ERROR_FILE_NOT_FOUND
 L’étendue de multidiffusion spécifiée dans ScopeInfo est introuvable sur le serveur DHCP.

Remarques

Lorsque cette fonction est appelée pour la première fois, elle crée la valeur d’option fournie dans la base de données du serveur DHCP. Sinon, elle modifie la valeur d’option d’une option spécifique associée à la classe d’utilisateur et à la classe de fournisseur par défaut. Ces valeurs peuvent être définies pour le niveau de réservation par défaut, serveur, étendue ou IPv4 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_DATA

DHCP_OPTION_SCOPE_INFO

DhcpSetOptionValueV5

DhcpSetOptionValues