Fonction DhcpV4EnumSubnetClients (dhcpsapi.h)

  • Article

La fonction DhcpV4EnumSubnetClients énumère tous les enregistrements clients DHCP mis en service à partir du sous-réseau IPv4 spécifié.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpV4EnumSubnetClients(
  [in, optional] DHCP_CONST WCHAR            *ServerIpAddress,
  [in]           DHCP_IP_ADDRESS             SubnetAddress,
  [in, out]      DHCP_RESUME_HANDLE          *ResumeHandle,
  [in]           DWORD                       PreferredMaximum,
  [out]          LPDHCP_CLIENT_INFO_PB_ARRAY *ClientInfo,
  [out]          DWORD                       *ClientsRead,
  [out]          DWORD                       *ClientsTotal
);

Paramètres

[in, optional] ServerIpAddress

Pointeur vers une chaîne Unicode terminée par null qui représente l’adresse IP ou le nom d’hôte du serveur DHCP.

[in] SubnetAddress

DHCP_IP_ADDRESS structure qui contient l’adresse de sous-réseau IPv4 des enregistrements clients DHCP à énumérer. Si la valeur est 0, les enregistrements du client DHCP pour tous les sous-réseaux IPv4 connus sont retournés.

[in, out] ResumeHandle

Pointeur vers une structure de DHCP_RESUME_HANDLE qui identifie cette énumération pour une utilisation dans les appels suivants à cette fonction. Initialement, cette valeur doit être égale à zéro lors de l’entrée. En cas de réussite, la valeur retournée doit être utilisée pour les 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

Nombre maximal d’octets d’enregistrements clients à retourner dans ClientInfo. La valeur minimale est 1 024 octets et la valeur maximale est 65536 octets.

[out] ClientInfo

Pointeur vers une structure DHCP_CLIENT_INFO_PB_ARRAY qui contient le jeu d’enregistrements de bail du client DHCP disponible pour le sous-réseau spécifié.

[out] ClientsRead

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

[out] ClientsTotal

Pointeur vers un DWORD qui spécifie le nombre d’enregistrements clients sur le serveur DHCP qui n’ont pas encore été énumérés.

Valeur retournée

Si la fonction réussit, elle retourne ERROR_SUCCESS.

Si la fonction échoue, elle retourne l’un des codes d’erreur suivants ou un code d’erreur à partir des codes d’erreur de l’API gestion du serveur DHCP.

Valeur Signification
ERROR_ACCESS_DENIED
 Cet appel a été effectué par un client qui n’est pas membre des groupes de sécurité Utilisateurs DHCP ou 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 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 reprise retourné pour obtenir plus d’enregistrements.
ERROR_NO_MORE_ITEMS
 Il n’existe aucun enregistrement de bail client sur le serveur DHCP.

Remarques

ClientInfo doit être gratuit à l’aide de DhcpRpcFreeMemory.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Aucun pris en charge
Serveur minimal pris en charge Windows Server 2012 [applications de bureau uniquement]
Plateforme cible Windows
En-tête dhcpsapi.h
Bibliothèque Dhcpsapi.lib
DLL Dhcpsapi.dll