DhcpEnumClasses, fonction (dhcpsapi.h)

Article
08/23/2023

La fonction DhcpEnumClasses énumère les classes d’utilisateur ou de fournisseur configurées pour le serveur DHCP.

Syntaxe

DWORD DhcpEnumClasses(
  [in]      LPWSTR                  ServerIpAddress,
  [in]      DWORD                   ReservedMustBeZero,
  [in, out] DHCP_RESUME_HANDLE      *ResumeHandle,
  [in]      DWORD                   PreferredMaximum,
  [out]     LPDHCP_CLASS_INFO_ARRAY *ClassInfoArray,
  [out]     DWORD                   *nRead,
  [out]     DWORD                   *nTotal
);

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] ReservedMustBeZero

Réservé. Ce champ doit être défini sur zéro.

[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 100 classes et que 200 classes sont stockées sur le serveur, le handle de reprise peut être utilisé après la récupération des 100 premières classes pour obtenir les 100 classes suivantes lors d’un appel suivant, et ainsi de suite.

[in] PreferredMaximum

Spécifie le nombre maximal de classes à retourner par défaut. Si le nombre de classes non chiffrées restantes est inférieur à cette valeur, ce montant est retourné. Pour récupérer toutes les classes disponibles sur le serveur DHCP, définissez ce paramètre sur 0xFFFFFFFF.

[out] ClassInfoArray

Pointeur vers une structure DHCP_CLASS_INFO_ARRAY qui contient les classes retournées. Si aucune classe n’est disponible sur le serveur DHCP, ce paramètre retourne null.

[out] nRead

Pointeur vers une valeur DWORD qui spécifie le nombre de classes retournées dans ClassInfoArray.

[out] nTotal

Pointeur vers une valeur DWORD qui spécifie le nombre total de classes stockées sur le serveur DHCP.

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.

Spécifications


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_CLASS_INFO_ARRAY

DhcpCreateClass

DhcpDeleteClass