Fonction DhcpV4EnumSubnetReservations (dhcpsapi.h)

Article
08/23/2023

La fonction DhcpV4EnumSubnetReservations énumère les réservations pour un sous-réseau IPv4 DHCP spécifique.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpV4EnumSubnetReservations(
  [in, optional] DHCP_CONST WCHAR              *ServerIpAddress,
  [in]           DHCP_IP_ADDRESS               SubnetAddress,
  [in, out]      DHCP_RESUME_HANDLE            *ResumeHandle,
  [in]           DWORD                         PreferredMaximum,
  [out]          LPDHCP_RESERVATION_INFO_ARRAY *EnumElementInfo,
  [out]          DWORD                         *ElementsRead,
  [out]          DWORD                         *ElementsTotal
);

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 réservations à énumérer.

[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 en entrée. En cas de réussite, la valeur retournée doit être utilisée pour les demandes d’énumération suivantes. Par exemple, si PreferredMaximum a la valeur 100 et que 200 éléments de réservation sont configurés sur le serveur, le handle de cv peut être utilisé après la récupération des 100 premières stratégies pour obtenir les 100 suivantes lors d’un appel suivant.

[in] PreferredMaximum

Nombre maximal d’octets de réservations de sous-réseau à retourner dans EnumInfo. Si PreferredMaximum est supérieur au nombre d’octets non énumérés restants de réservations de sous-réseau sur le serveur, le nombre restant d’octets non énumérés est retourné. Pour récupérer tous les éléments de réservation de sous-réseau, définissez ce paramètre sur 0xFFFFFFFF.

[out] EnumElementInfo

Pointeur vers une structure DHCP_RESERVATION_INFO_ARRAY qui contient les éléments de réservation disponibles pour le sous-réseau spécifié. Si aucun élément n’est configuré, cette valeur est NULL.

[out] ElementsRead

Pointeur vers un DWORD qui spécifie le nombre d’éléments de réservation retournés dans EnumElementInfo.

[out] ElementsTotal

Pointeur vers un DWORD qui spécifie le nombre de réservations sur le serveur DHCP qui n’ont pas encore été énumérées.

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_INVALID_PARAMETER	Un ou plusieurs des paramètres n’étaient pas valides.
ERROR_MORE_DATA	Il existe d’autres éléments disponibles pour énumérer.
ERROR_NO_MORE_ITEMS	Il ne reste plus d’éléments à énumérer.
ERROR_DHCP_SUBNET_NOT_PRESENT	Le sous-réseau IPv4 n’existe pas sur le serveur DHCPv4.

Remarques

EnumElementInfo 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