Fonction DhcpGetAllOptionValues (dhcpsapi.h)

  • Article

La fonction DhcpGetAllOptionValues retourne un tableau qui contient toutes les valeurs d’option définies pour une étendue spécifique sur le serveur DHCP.

Syntaxe

DWORD DhcpGetAllOptionValues(
  [in]  LPWSTR                   ServerIpAddress,
  [in]  DWORD                    Flags,
  [in]  LPDHCP_OPTION_SCOPE_INFO ScopeInfo,
  [out] LPDHCP_ALL_OPTION_VALUES *Values
);

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 les options sont spécifiques au fournisseur. Si la qualification des options du fournisseur n’est pas nécessaire, ce paramètre doit être 0.

Valeur Signification
DHCP_FLAGS_OPTION_IS_VENDOR
 Cet indicateur doit être défini si des options spécifiques au fournisseur sont souhaitées.

[in] ScopeInfo

Pointeur vers une structure DHCP_OPTION_SCOPE_INFO qui contient des informations sur l’étendue spécifique dont les valeurs d’option seront retournées. Ces informations définissent les valeurs d’option qui sont récupérées à partir du niveau par défaut, du serveur ou de l’étendue, ou pour une réservation IPv4 spécifique.

[out] Values

Pointeur vers une structure DHCP_ALL_OPTION_VALUES qui contient les valeurs d’option retournées pour l’étendue spécifiée dans ScopeInfo.

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_SUBNET_NOT_PRESENT
 Ce sunet IPv4 spécifié n’est pas défini sur le serveur DHCP.
ERROR_DHCP_NOT_RESERVED_CLIENT
 Le client DHCP spécifié n’est pas un client réservé.

Remarques

Il y aura une valeur d’option dans le tableau spécifiée par Valeurs pour chaque paire fournisseur/classe définie 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

DhcpGetAllOptions