DhcpEnumOptionValuesV6, fonction (dhcpsapi.h)

Article
02/28/2024

La fonction DhcpEnumOptionValuesV6 retourne une liste énumérée de valeurs d’option (les données d’option et le numéro d’ID associé) pour une étendue spécifique au sein d’une classe donnée.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpEnumOptionValuesV6(
  [in]      DHCP_CONST WCHAR          *ServerIpAddress,
  [in]      DWORD                     Flags,
  [in]      LPWSTR                    ClassName,
  [in]      LPWSTR                    VendorName,
  [in]      LPDHCP_OPTION_SCOPE_INFO6 ScopeInfo,
  [in, out] DHCP_RESUME_HANDLE        *ResumeHandle,
  [in]      DWORD                     PreferredMaximum,
  [out]     LPDHCP_OPTION_VALUE_ARRAY *OptionValues,
  [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. S’il n’est pas spécifique au fournisseur, 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 valeurs d’option de l’étendue seront énumérées.

[in] VendorName

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

[in] ScopeInfo

DHCP_OPTION_SCOPE_INFO6 structure qui contient l’étendue pour laquelle les valeurs d’option sont définies.

[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 valeurs d’option 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 1000 suivants lors d’un appel suivant, et ainsi de suite.

[in] PreferredMaximum

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

[out] OptionValues

Pointeur vers une structure DHCP_OPTION_VALUE_ARRAY qui contient les valeurs d’option énumérées retournées pour l’étendue spécifiée. Si aucune valeur d’option n’est disponible pour cette étendue sur le serveur DHCP, ce paramètre retourne null.

[out] OptionsRead

Pointeur vers une valeur DWORD qui spécifie le nombre de valeurs d’option retournées dans OptionValues.

[out] OptionsTotal

Pointeur vers une valeur DWORD qui spécifie le nombre total de valeurs d’option pour cette étendue stockée 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