DhcpEnumSubnetsV6, fonction (dhcpsapi.h)
La fonction DhcpEnumSubnetsV6 retourne une liste énumérée de sous-réseaux définis sur le serveur DHCP.
Syntaxe
DWORD DHCP_API_FUNCTION DhcpEnumSubnetsV6(
[in] DHCP_CONST WCHAR *ServerIpAddress,
[in, out] DHCP_RESUME_HANDLE *ResumeHandle,
[in] DWORD PreferredMaximum,
[out] LPDHCPV6_IP_ARRAY *EnumInfo,
[out] DWORD *ElementsRead,
[out] DWORD *ElementsTotal
);
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, 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 100 et que 200 adresses de sous-réseau sont stockées sur le serveur, le handle de reprise peut être utilisé après la récupération des 100 premiers sous-réseaux pour obtenir les 100 suivants lors d’un appel suivant, et ainsi de suite.
[in] PreferredMaximum
Spécifie le nombre maximal préféré d’adresses de sous-réseau à retourner. Si le nombre d’options non chiffrées restantes est inférieur à cette valeur, ce montant est retourné.
[out] EnumInfo
Pointeur vers une structure DHCPV6_IP_ARRAY qui contient les ID de sous-réseau disponibles sur le serveur DHCP. Si aucun sous-réseau n’est défini, cette valeur est null.
[out] ElementsRead
Pointeur vers une valeur DWORD qui spécifie le nombre d’adresses de sous-réseau retournées dans EnumInfo.
[out] ElementsTotal
Pointeur vers une valeur DWORD qui spécifie le nombre de sous-réseaux définis sur le serveur DHCP qui n’ont pas encore été énumérés.
Valeur retournée
Cette fonction retourne ERROR_SUCCESS en cas d’appel réussi. Si un appel est effectué avec la même valeur ResumeHandle et que tous les éléments sur le serveur ont été énumérés, cette méthode retourne ERROR_NO_MORE_ITEMS avec ElementsRead et ElementsTotal définis sur 0. Sinon, elle retourne l’un des codes d’erreur de l’API Gestion du serveur DHCP.
Code de retour | Description |
---|---|
|
Les paramètres n’étaient pas valides. |
|
Plus d'éléments à énumérer. |
|
Échec de mémoire. |
|
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 |