Fonction DhcpEnumOptionsV5 (dhcpsapi.h)

La fonction DhcpEnumOptionsV5 retourne une liste énumérée d’options DHCP pour une classe d’utilisateur ou de fournisseur donnée.

Syntaxe

DWORD DhcpEnumOptionsV5(
  [in]      LPWSTR              ServerIpAddress,
  [in]      DWORD               Flags,
  [in]      LPWSTR              ClassName,
  [in]      LPWSTR              VendorName,
  [in, out] DHCP_RESUME_HANDLE  *ResumeHandle,
  [in]      DWORD               PreferredMaximum,
  [out]     LPDHCP_OPTION_ARRAY *Options,
  [out]     DWORD               *OptionsRead,
  [out]     DWORD               *OptionsTotal
);

Paramètres

[in] ServerIpAddress

Chaîne Unicode qui spécifie l’adresse IP ou le nom d’hôte du serveur DHCP.

[in] Flags

Ensemble d’indicateurs qui indiquent la définition d’option pour l’énumération.

Valeur	Signification
0x00000000	Les définitions d’options sont énumérées pour une classe de fournisseur par défaut.
DHCP_FLAGS_OPTION_IS_VENDOR 0x00000003	Les définitions d’options sont énumérées pour une classe de fournisseur spécifique.

[in] ClassName

Pointeur vers une chaîne Unicode qui contient le nom de la classe dont les options seront énumérées. Ce paramètre est facultatif.

[in] VendorName

Pointeur vers une chaîne Unicode qui contient le nom du fournisseur de la classe . Ce paramètre est facultatif. Si aucun nom de classe de fournisseur n’est fourni, le nom de classe fournisseur par défaut est utilisé.

[in, out] ResumeHandle

Pointeur vers une valeur DHCP_RESUME_HANDLE qui identifie l’opération d’énumération. Initialement, cette valeur doit être égale à zéro, un appel réussi retournant la valeur de handle utilisée pour les demandes d’énumération suivantes. Par exemple, si PreferredMaximum est défini sur 1 000 octets et que 2 000 octets de définitions d’options sont stockés sur le serveur, le handle de cv peut être utilisé après la récupération des 1000 premiers octets pour obtenir les 1000 suivants lors d’un appel suivant, et ainsi de suite.

[in] PreferredMaximum

Spécifie le nombre maximal d’octets d’options à retourner. Si le nombre de définitions d’options non chiffrées restantes (en octets) est inférieur à cette valeur, toutes les définitions d’option sont retournées.

[out] Options

Pointeur vers une structure de DHCP_OPTION_ARRAY contenant les définitions d’option retournées. Si aucune définition d’option n’est disponible sur le serveur DHCP, ce paramètre retourne null.

[out] OptionsRead

Pointeur vers une valeur DWORD qui spécifie le nombre de définitions d’options retournées dans Options.

[out] OptionsTotal

Pointeur vers une valeur DWORD qui spécifie le nombre total de définitions d’options non chiffrées sur le serveur DHCP.

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_CLASS_NOT_FOUND	Le nom de classe de l’utilisateur ou du fournisseur fourni est incorrect ou inconnu.

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_ARRAY

DhcpCreateOptionV5

DhcpRemoveOptionV5