DhcpEnumOptionsV6, fonction (dhcpsapi.h)

Article
08/23/2023

La fonction DhcpEnumOptionsV6 retourne une liste énumérée d’options DHCP pour une classe et/ou un fournisseur donnés.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpEnumOptionsV6(
  [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

Pointeur vers une 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. 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] ClassName

Chaîne Unicode qui contient le nom de la classe dont les options seront énumérées.

[in] VendorName

Chaîne Unicode qui contient le nom du fournisseur pour la classe . Ce paramètre est facultatif.

[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 d’options sont stockés sur le serveur, le handle de reprise peut être utilisé après la récupération des 1 000 premiers octets pour obtenir les 1 000 suivants lors d’un appel suivant, et ainsi de suite.

[in] PreferredMaximum

Spécifie le nombre maximal d’octets d’options à retourner par défaut. Si le nombre d’options non chiffrées restantes (en octets) est inférieur à cette valeur, ce montant est retourné.

[out] Options

Pointeur vers une structure DHCP_OPTION_ARRAY contenant les options retournées. Si aucune 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 d’options retournées dans Options.

[out] OptionsTotal

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

Valeur retournée

Cette fonction retourne ERROR_SUCCESS en cas d’appel réussi. Sinon, elle retourne l’un des codes d’erreur de l’API Gestion du serveur DHCP.

Code de retour	Description
ERROR_INVALID_PARAMETER	Les paramètres n’étaient pas valides.
ERROR_NO_MORE_ITEMS	Plus d'éléments à énumérer.
ERROR_NOT_ENOUGH_MEMORY	Échec de mémoire.
ERROR_MORE_DATA	Plus de données sont disponibles pour énumérer.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	dhcpsapi.h
Bibliothèque	Dhcpsapi.lib
DLL	Dhcpsapi.dll