Fonction DhcpEnumOptions (dhcpsapi.h)
La fonction DhcpEnumOptions retourne un ensemble énuméré d’options stockées sur le serveur DHCPv4.
Syntaxe
DWORD DHCP_API_FUNCTION DhcpEnumOptions(
[in] DHCP_CONST WCHAR *ServerIpAddress,
[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 IPv4 du serveur DHCP.
[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 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.
La présence de données énumérables supplémentaires est indiquée lorsque cette fonction retourne ERROR_MORE_DATA. Si aucune donnée énumérable supplémentaire n’est disponible sur le serveur DHCPv4, ERROR_NO_MORE_ITEMS est retourné.
[in] PreferredMaximum
Spécifie le nombre maximal d’octets d’options à retourner. Si le nombre d’options non chiffrées restantes (en octets) est inférieur à cette valeur, ce montant est retourné.
Pour récupérer toutes les définitions d’options pour la classe d’utilisateur et de fournisseur par défaut, définissez ce paramètre sur 0xFFFFFFFF.
[out] Options
Pointeur vers une structure DHCP_OPTION_ARRAY contenant les options retournées. S’il n’existe aucune option disponible sur le serveur DHCPv4, 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 restantes stockées sur le serveur DHCPv4.
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 |
---|---|
|
Une erreur s’est produite lors de l’accès à la base de données du serveur DHCP. |
|
Il existe d’autres éléments disponibles pour énumérer. |
|
Il ne reste plus d’éléments à énumérer. |
Remarques
L’appelant de cette fonction doit libérer la mémoire pointée par Options une fois l’appel terminé.
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 |