Fonction DhcpEnumSubnetClientsV5 (dhcpsapi.h)
La fonction DhcpEnumSubnetClientsV5 retourne une liste énumérée de clients avec des adresses IP servies dans le sous-réseau spécifié. Cette fonction étend les fonctionnalités fournies dans la fonction DhcpEnumSubnetClients en renvoyant une liste de structures DHCP_CLIENT_INFO_V5 qui contiennent le type de client spécifique (DHCP et/ou BOOTP) et l’état de l’adresse IP.
Syntaxe
DWORD DHCP_API_FUNCTION DhcpEnumSubnetClientsV5(
[in] DHCP_CONST WCHAR *ServerIpAddress,
[in] DHCP_IP_ADDRESS SubnetAddress,
[in, out] DHCP_RESUME_HANDLE *ResumeHandle,
[in] DWORD PreferredMaximum,
[out] LPDHCP_CLIENT_INFO_ARRAY_V5 *ClientInfo,
[out] DWORD *ClientsRead,
[out] DWORD *ClientsTotal
);
Paramètres
[in] ServerIpAddress
Chaîne UNICODE qui spécifie l’adresse IP ou le nom d’hôte du serveur DHCP.
[in] SubnetAddress
Valeur contenant l’adresse IP de la passerelle de sous-réseau. Si ce paramètre est défini sur 0, les clients DHCP de tous les sous-réseaux IPv4 définis sur le serveur DHCP sont retournés.
[in, out] ResumeHandle
Pointeur vers un 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 structures d’informations clientes de sous-réseau sont stockés sur le serveur, le handle de cv 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
Nombre maximal d’octets préférés des structures d’informations clientes de sous-réseau à retourner. Si le nombre d’options non chiffrées restantes (en octets) est inférieur à cette valeur, ce montant est retourné.
[out] ClientInfo
Pointeur vers une structure de DHCP_CLIENT_INFO_ARRAY_V5 contenant des informations sur les clients desservis sous ce sous-réseau spécifique. Si aucun client n’est disponible, ce champ est null.
[out] ClientsRead
Pointeur vers une valeur qui spécifie le nombre de clients retournés dans ClientInfo.
[out] ClientsTotal
Pointeur vers une valeur qui spécifie le nombre total de clients pour le sous-réseau spécifié stocké sur le serveur DHCP.
Valeur retournée
La fonction DhcpEnumSubnetClientsV5 retourne ERROR_SUCCESS en cas de réussite.
En cas d’erreur, la fonction retourne l’un des codes d’erreur de l’API gestion du serveur DHCP.
Code de retour | Description |
---|---|
|
L’appel a été effectué par un client qui n’est pas membre du groupe de sécurité « Administrateurs DHCP ». |
|
Une erreur s’est produite lors de l’accès à la base de données du serveur DHCP. |
|
Il existe toujours des enregistrements de bail client non énumérés sur le serveur DHCP pour le sous-réseau IPv4 fourni. Appelez à nouveau cette fonction avec le handle de CV retourné pour en obtenir d’autres. |
Remarques
L’appelant de cette fonction doit libérer la mémoire utilisée par la structure DHCP_CLIENT_INFO_ARRAY_V5 retournée dans la mémoire tampon pointée par le paramètre ClientInfo lorsque les informations ne sont plus nécessaires.
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 |
Voir aussi
DHCP_RESUME_HANDLE