Fonction DhcpSetOptionValueV5 (dhcpsapi.h)

  • Article

La fonction DhcpSetOptionValueV5 définit des informations pour une valeur d’option spécifique sur le serveur DHCP. Cette fonction étend les fonctionnalités fournies par DhcpSetOptionValue en permettant à l’appelant de spécifier une classe et/ou un fournisseur pour l’option.

Syntaxe

DWORD DhcpSetOptionValueV5(
  [in]           LPWSTR                   ServerIpAddress,
  [in]           DWORD                    Flags,
  [in]           DHCP_OPTION_ID           OptionId,
  [in, optional] LPWSTR                   ClassName,
  [in, optional] LPWSTR                   VendorName,
  [in]           LPDHCP_OPTION_SCOPE_INFO ScopeInfo,
  [in]           LPDHCP_OPTION_DATA       OptionValue
);

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 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 l’option en cours de définition. 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/rfc2132.txt.

[in, optional] ClassName

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

[in, optional] VendorName

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

[in] ScopeInfo

Pointeur vers une structure de DHCP_OPTION_SCOPE_INFO qui contient des informations décrivant l’étendue DHCP sur laquelle cette valeur d’option sera définie.

[in] OptionValue

Pointeur vers une structure de 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, il retourne l’un des codes d’erreur de l’API gestion du serveur DHCP.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Aucun pris en charge
Serveur minimal pris en charge Windows 2000 Server [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

DhcpV4SetOptionValue