Fonction DhcpV4SetOptionValues (dhcpsapi.h)

  • Article

La fonction DhcpV4SetOptionValues définit les codes d’option et les valeurs de données associées pour une étendue spécifique définie sur le serveur DHCP. Cette fonction étend les fonctionnalités fournies par DhcpSetOptionValuesV5 en permettant à l’appelant de spécifier une stratégie pour les options.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpV4SetOptionValues(
  [in, optional] LPWSTR                    ServerIpAddress,
  [in]           DWORD                     Flags,
  [in, optional] LPWSTR                    PolicyName,
  [in, optional] LPWSTR                    VendorName,
  [in]           LPDHCP_OPTION_SCOPE_INFO  ScopeInfo,
  [in]           LPDHCP_OPTION_VALUE_ARRAY OptionValues
);

Paramètres

[in, optional] ServerIpAddress

Pointeur vers une chaîne Unicode terminée par null qui représente l’adresse IP ou le nom d’hôte du serveur DHCP.

[in] Flags

Réservé. Doit être égal à 0.

[in, optional] PolicyName

Chaîne Unicode terminée par null qui représente le nom de la stratégie à l’intérieur du sous-réseau de la valeur d’option à définir. Le sous-réseau est identifié par le membre SubnetScopeInfo de ScopeInfo.

[in, optional] VendorName

Chaîne Unicode terminée par null qui représente le fournisseur de l’option. Ce paramètre est facultatif et, si null, la valeur d’option est définie pour le fournisseur par défaut.

[in] ScopeInfo

Pointeur vers une structure de DHCP_OPTION_SCOPE_INFO qui contient des informations décrivant l’étendue DHCP des valeurs d’option à définir. Ce paramètre spécifie si la valeur de l’option est définie pour le niveau par défaut, serveur ou étendue, ou pour une réservation IPv4.

[in] OptionValues

Pointeur vers une structure de DHCP_OPTION_VALUE_ARRAY qui contient une liste de codes d’option et la valeur de données correspondante qui sera définie.

Valeur retournée

Si la fonction réussit, elle retourne ERROR_SUCCESS.

Si la fonction échoue, elle retourne l’un des codes d’erreur suivants ou un code d’erreur à partir des codes d’erreur de l’API gestion du serveur DHCP.

Valeur Signification
ERROR_INVALID_PARAMETER
 Un ou plusieurs des paramètres n’étaient pas valides.
ERROR_DHCP_SUBNET_NOT_PRESENT
 Le sous-réseau IPv4 spécifié n’existe pas.
ERROR_DHCP_CLASS_NOT_FOUND
 Le nom de classe utilisé est inconnu ou incorrect.
ERROR_DHCP_POLICY_NOT_FOUND
 Le nom de stratégie spécifié n’existe pas.
ERROR_DHCP_OPTION_NOT_PRESENT
 La définition d’option spécifiée n’existe pas sur la base de données du serveur DHCP.
ERROR_DHCP_NOT_RESERVED_CLIENT
 Le client DHCP spécifié n’est pas un client réservé.

Remarques

OptionValues et son membre, Values, doivent être gratuits à l’aide de DhcpRpcFreeMemory.

Configuration requise

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

Voir aussi

DhcpV4GetAllOptionValues

DhcpV4GetOptionValue

DhcpV4RemoveOptionValue

DhcpV4SetOptionValue