Fonction DhcpEnumSubnetClients (dhcpsapi.h)
La fonction DhcpEnumSubnetClients retourne une liste énumérée de clients avec des adresses IP servies dans le sous-réseau spécifié.
Syntaxe
DWORD DHCP_API_FUNCTION DhcpEnumSubnetClients(
[in] DHCP_CONST WCHAR *ServerIpAddress,
[in] DHCP_IP_ADDRESS SubnetAddress,
[in, out] DHCP_RESUME_HANDLE *ResumeHandle,
[in] DWORD PreferredMaximum,
[out] LPDHCP_CLIENT_INFO_ARRAY *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 qui contient l’ID de sous-réseau. Pour plus d’informations sur l’ID de sous-réseau, consultez RFC 950 .
[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 de structures d’informations clientes de sous-réseau sont stockés sur le serveur, le handle de reprise peut être utilisé après la récupération des 1 000 premiers octets pour obtenir les 1 000 suivants lors d’un appel suivant, et ainsi de suite.
[in] PreferredMaximum
Spécifie le 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é.
La valeur minimale est 1 024 octets (1 Ko) et la valeur maximale est 65 536 octets (64 Ko) ; si la valeur d’entrée est supérieure ou inférieure à cette plage, elle est définie sur la valeur maximale ou minimale, respectivement.
[out] ClientInfo
Pointeur vers une structure DHCP_CLIENT_INFO_ARRAY qui contient des informations sur les clients servis sous ce sous-réseau spécifique. Si aucun client n’est disponible, ce champ est null.
[out] ClientsRead
Pointeur vers une valeur DWORD qui spécifie le nombre de clients retournés dans ClientInfo.
[out] ClientsTotal
Pointeur vers une valeur DWORD qui spécifie le nombre de clients pour le sous-réseau spécifié qui n’ont pas encore été énumérés.
Valeur retournée
Cette fonction retourne ERROR_MORE_DATA lors d’un appel réussi. L’appel final à cette méthode avec le dernier ensemble de clients de sous-réseau retourne ERROR_SUCCESS. Sinon, elle retourne l’un des codes d’erreur de l’API Gestion du serveur DHCP.
Notes
Cette fonction nécessite l’ordre des octets de l’hôte pour toutes les valeurs DHCP_IP_ADDRESS dans les structures de paramètres.
Spécifications
Client minimal pris en charge | Aucun pris en charge |
Serveur minimal pris en charge | Windows 2000 Server [applications de bureau uniquement] |
Plateforme cible | Windows |
En-tête | dhcpsapi.h |
Bibliothèque | Dhcpsapi.lib |
DLL | Dhcpsapi.dll |