Fonction DhcpEnumSubnetClientsV4 (dhcpsapi.h)
La fonction DhcpEnumSubnetClientsV4 retourne une liste énumérée d’enregistrements de bail client avec des adresses IP servies dans le sous-réseau spécifié. Cette fonction étend les fonctionnalités fournies dans DhcpEnumSubnetClients en retournant une liste de structures DHCP_CLIENT_INFO_V4 qui contiennent le type de client spécifique (DHCP et/ou BOOTP).
Syntaxe
DWORD DHCP_API_FUNCTION DhcpEnumSubnetClientsV4(
[in] DHCP_CONST WCHAR *ServerIpAddress,
[in] DHCP_IP_ADDRESS SubnetAddress,
[in, out] DHCP_RESUME_HANDLE *ResumeHandle,
[in] DWORD PreferredMaximum,
[out] LPDHCP_CLIENT_INFO_ARRAY_V4 *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
DHCP_IP_ADDRESS valeur contenant l’adresse IP de la passerelle de sous-réseau.
[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. Ce paramètre contient la dernière adresse IPv4 récupérée à partir du client DHCPv4.
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’éléments client de sous-réseau à retourner. Si le nombre d’éléments non chiffrés restants (en octets) est inférieur à cette valeur, ce montant est retourné. La valeur minimale est 1 024 octets et la valeur maximale est 65536 octets.
Pour récupérer tous les éléments clients de sous-réseau pour la classe d’utilisateur et de fournisseur par défaut au niveau spécifié, définissez ce paramètre sur 0xFFFFFFFF.
[out] ClientInfo
Pointeur vers une structure DHCP_CLIENT_INFO_ARRAY_V4 qui contient le tableau d’enregistrements de bail client DHCPv4. Si aucun client n’est disponible, ce champ est null.
[out] ClientsRead
Pointeur vers une valeur DWORD qui spécifie le nombre d’enregistrements de bail client retournés dans ClientInfo.
[out] ClientsTotal
Pointeur vers une valeur DWORD qui spécifie le nombre total d’enregistrements de bail client restant sur le serveur DHCPv4. Par exemple, s’il existe 100 enregistrements de bail DHCPv4 pour un sous-réseau IPv4 et si 10 enregistrements de bail DHCPv4 sont énumérés par appel, ce paramètre retourne une valeur de 90 après le premier appel.
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. |
|
Le sous-réseau IPv4 spécifié n’existe pas sur le serveur DHCP. |
Remarques
L’appelant de cette fonction doit libérer la mémoire pour ClientInfo 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 |