Fonction DhcpGetOptionValueV5 (dhcpsapi.h)

  • Article

La fonction DhcpGetOptionValueV5 récupère une valeur d’option DHCP (le code d’option et les données associées) pour une étendue particulière. Cette fonction étend les fonctionnalités fournies par DhcpGetOptionValue en permettant à l’appelant de spécifier une classe et/ou un fournisseur pour l’option.

Syntaxe

DWORD DhcpGetOptionValueV5(
  [in]  LPWSTR                   ServerIpAddress,
  [in]  DWORD                    Flags,
  [in]  DHCP_OPTION_ID           OptionID,
  [in]  LPWSTR                   ClassName,
  [in]  LPWSTR                   VendorName,
  [in]  LPDHCP_OPTION_SCOPE_INFO ScopeInfo,
  [out] LPDHCP_OPTION_VALUE      *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

Valeur d’indicateur qui indique si l’option concerne une classe de fournisseur spécifique ou par défaut.

Valeur Signification
0x00000000
 La valeur de l’option est récupérée pour une classe fournisseur par défaut.
DHCP_FLAGS_OPTION_IS_VENDOR
0x00000003
 La valeur de l’option est récupérée pour une classe de fournisseur spécifique. Le nom du fournisseur est fourni dans VendorName.

[in] OptionID

DHCP_OPTION_ID valeur qui spécifie le code de la valeur d’option à récupérer.

[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 Flags n’est pas défini sur DHCP_FLAGS_OPTION_IS_VENDOR. Si la classe fournisseur n’est pas spécifiée, la valeur d’option est retournée pour la classe fournisseur par défaut.

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO structure qui contient des informations sur l’étendue où la valeur d’option est définie.

[out] OptionValue

DHCP_OPTION_VALUE structure qui contient le code et les données d’option retournés.

Remarque  

La mémoire de ce paramètre doit être libre à l’aide de DhcpRpcFreeMemory.

 

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.

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_SUBNET_NOT_PRESENT
 Le sous-réseau IPv4 spécifié n’est pas défini sur le 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_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

DHCP_OPTION_VALUE

DhcpGetOptionValue

DhcpSetOptionValueV5