Fonction DhcpEnumSubnetClientsV6 (dhcpsapi.h)

  • Article

La fonction DhcpEnumSubnetClientsV6 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 DhcpEnumSubnetClientsV6(
  [in]      DHCP_CONST WCHAR            *ServerIpAddress,
  [in]      DHCP_IPV6_ADDRESS           SubnetAddress,
  [in, out] DHCP_RESUME_IPV6_HANDLE     *ResumeHandle,
  [in]      DWORD                       PreferredMaximum,
  [out]     LPDHCP_CLIENT_INFO_ARRAY_V6 *ClientInfo,
  [out]     DWORD                       *ClientsRead,
  [out]     DWORD                       *ClientsTotal
);

Paramètres

[in] ServerIpAddress

Pointeur vers une chaîne Unicode qui spécifie l’adresse IP ou le nom d’hôte du serveur DHCP.

[in] SubnetAddress

DHCP_IPV6_ADDRESS valeur contenant l’adresse IP de la passerelle de sous-réseau.

[in, out] ResumeHandle

Pointeur vers une valeur DHCP_RESUME_IPV6_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

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é.

[out] ClientInfo

Pointeur vers une structure de DHCP_CLIENT_INFO_ARRAY_V6 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 DWORD qui spécifie le nombre de clients retournés dans ClientInfo.

[out] ClientsTotal

Pointeur vers une valeur DWORD qui spécifie le nombre total de clients pour le sous-réseau spécifié stocké sur le serveur DHCP.

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
ERROR_INVALID_PARAMETER
 Les paramètres n’étaient pas valides.
ERROR_NO_MORE_ITEMS
 Plus d'éléments à énumérer.
ERROR_NOT_ENOUGH_MEMORY
 Échec de mémoire.
ERROR_MORE_DATA
 D’autres données sont disponibles pour énumérer.

Configuration requise

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