Fonction DhcpEnumOptionValuesV5 (dhcpsapi.h)
La fonction DhcpEnumOptionValuesV5 retourne une liste énumérée de valeurs d’option (uniquement les données d’option et le numéro d’ID associé) pour une étendue spécifique au sein d’une classe d’utilisateur ou de fournisseur donnée.
Syntaxe
DWORD DhcpEnumOptionValuesV5(
[in] LPWSTR ServerIpAddress,
[in] DWORD Flags,
[in] LPWSTR ClassName,
[in] LPWSTR VendorName,
[in] LPDHCP_OPTION_SCOPE_INFO 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
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. S’il n’est pas spécifique au fournisseur, ce paramètre doit être 0.
[in] ClassName
Pointeur vers une chaîne Unicode qui contient le nom de la classe dont les valeurs d’option d’étendue seront énumérées.
[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, les valeurs d’option sont énumérées pour une classe de fournisseur par défaut.
[in] ScopeInfo
Pointeur vers une structure DHCP_OPTION_SCOPE_INFO qui contient l’étendue pour laquelle les valeurs d’option sont définies. Cette valeur définit les valeurs d’option qui seront récupérées à partir du serveur, de l’étendue ou du niveau par défaut, ou pour une réservation IPv4.
[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 1000 octets et que 2 000 octets de valeurs d’option sont stockées sur le serveur, le handle de cv peut être utilisé après que les 1 000 premiers octets ont été récupérés pour obtenir les 1000 suivants lors d’un appel suivant, et ainsi de suite.
[in] PreferredMaximum
Spécifie le nombre maximal d’octets de valeurs d’option à retourner. Si le nombre d’options non chiffrées restantes (en octets) est inférieur à cette valeur, toutes les valeurs d’option sont retournées.
[out] OptionValues
Pointeur vers une structure de 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 non chiffrées pour cette étendue stockée 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 |
|---|---|
|
Cet appel a été effectué par un client qui n’est pas membre du groupe de sécurité « Administrateurs DHCP ». |
|
Le nom de classe de l’utilisateur ou du fournisseur fourni est incorrect ou inconnu. |
|
Le sous-réseau IPv4 spécifié n’est pas défini sur le serveur DHCP. |
|
Le client DHCP spécifié n’est pas un client réservé. |
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
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour