Fonction DhcpGetOptionInfoV5 (dhcpsapi.h)

  • Article

La fonction DhcpGetOptionInfoV5 retourne des informations sur une option DHCP spécifique.

Syntaxe

DWORD DhcpGetOptionInfoV5(
  [in]  LPWSTR         ServerIpAddress,
  [in]  DWORD          Flags,
  [in]  DHCP_OPTION_ID OptionID,
  [in]  LPWSTR         ClassName,
  [in]  LPWSTR         VendorName,
  [out] LPDHCP_OPTION  *OptionInfo
);

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
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 l’option sur laquelle récupérer des informations.

[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 être null lorsque Flags n’est pas défini sur DHCP_FLAGS_OPTION_IS_VENDOR. S’il n’est pas défini, la définition d’option de la classe fournisseur par défaut est retournée.

[out] OptionInfo

Pointeur vers une structure DHCP_OPTION qui contient les informations retournées sur l’option spécifiée par OptionID.

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é. o

Spécifications

   
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

DhcpSetOptionInfoV5