DhcpEnumSubnetClientsFilterStatusInfo, fonction (dhcpsapi.h)

  • Article

La fonction DhcpEnumSubnetClientsFilterStatusInfo énumère tous les clients DHCP mis en service sur le sous-réseau spécifié et inclut des filtres de couche de liens status pour chacun d’eux.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpEnumSubnetClientsFilterStatusInfo(
  [in]      DHCP_CONST WCHAR                       *ServerIpAddress,
  [in]      DHCP_IP_ADDRESS                        SubnetAddress,
  [in, out] DHCP_RESUME_HANDLE                     *ResumeHandle,
  [in]      DWORD                                  PreferredMaximum,
  [out]     LPDHCP_CLIENT_FILTER_STATUS_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 le sous-réseau IPv4 pour lequel les clients DHCP sont retournés. Si ce paramètre est défini sur 0, les clients DHCP de tous les sous-réseaux IPv4 connus sont retournés.

[in, out] ResumeHandle

Pointeur vers une valeur DHCP_RESUME_HANDLE qui identifie l’opération d’énumération sur le serveur DHCP. Au départ, cette valeur doit être définie sur 0. Un appel réussi retourne une valeur de handle dans ce paramètre, qui peut être passée aux demandes d’énumération suivantes. La valeur de handle retournée est la dernière adresse IPv4 récupérée dans l’opération d’énumération.

[in] PreferredMaximum

Spécifie le nombre maximal d’octets préféré à retourner dans l’opération d’énumération. la valeur minimale est 1 024 octets et la valeur maximale est 65 536 octets.

[out] ClientInfo

Pointeur vers une structure de DHCP_CLIENT_FILTER_STATUS_INFO_ARRAY qui contient tous les clients DHCP sur le sous-réseau spécifié, ainsi que tout filtre de couche de liens associé status informations pour chacun d’eux.

[out] ClientsRead

Pointeur vers une valeur qui spécifie le nombre d’enregistrements clients DHCP retournés dans ClientInfo.

[out] ClientsTotal

Pointeur vers une valeur qui spécifie le nombre d’enregistrements clients DHCP restants et non encore retournés. Par exemple, s’il existe 100 enregistrements clients DHCP pour un sous-réseau IPv4 donné, et si 10 enregistrements clients sont énumérés par appel, cette valeur retourne 90 après le premier appel.

Valeur retournée

Cette fonction retourne ERROR_SUCCESS en cas d’appel réussi. Sinon, elle retourne l’un des codes d’erreur de l’API Gestion du serveur DHCP.

Code de retour Description
ERROR_ACCESS_DENIED
 Cet appel a été effectué par un client qui n’est pas membre du groupe de sécurité « Administrateurs DHCP ».
ERROR_DHCP_JET_ERROR
 Une erreur s’est produite lors de l’accès à la base de données du serveur DHCP.
ERROR_MORE_DATA
 Il existe encore des enregistrements de bail client non chiffrés sur le serveur DHCP pour le sous-réseau IPv4 fourni. Appelez à nouveau cette fonction avec le handle de reprise retourné pour en obtenir d’autres.

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_CLIENT_FILTER_STATUS_INFO_ARRAY