Fonction DhcpEnumSubnetElementsV5 (dhcpsapi.h)

  • Article

La fonction DhcpEnumSubnetElementsV5 retourne une liste énumérée d’éléments pour un sous-réseau DHCP spécifique.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpEnumSubnetElementsV5(
  [in]      DHCP_CONST WCHAR                    *ServerIpAddress,
  [in]      DHCP_IP_ADDRESS                     SubnetAddress,
  [in]      DHCP_SUBNET_ELEMENT_TYPE            EnumElementType,
  [in, out] DHCP_RESUME_HANDLE                  *ResumeHandle,
  [in]      DWORD                               PreferredMaximum,
  [out]     LPDHCP_SUBNET_ELEMENT_INFO_ARRAY_V5 *EnumElementInfo,
  [out]     DWORD                               *ElementsRead,
  [out]     DWORD                               *ElementsTotal
);

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 spécifie l’adresse du sous-réseau IP dont les éléments seront énumérés.

[in] EnumElementType

DHCP_SUBNET_ELEMENT_TYPE valeur d’énumération qui indique le type d’élément de sous-réseau à énumérer.

[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 1000 octets et que 2 000 octets d’éléments de sous-réseau sont stockés sur le serveur, le handle de cv peut être utilisé après que les 1 000 premiers octets ont été récupérés pour obtenir les 1000 suivants lors d’un appel suivant, et ainsi de suite.

La présence de données énumérables supplémentaires est indiquée lorsque cette fonction retourne ERROR_MORE_DATA. Si aucune donnée énumérable supplémentaire n’est disponible sur le serveur DHCPv4, ERROR_NO_MORE_ITEMS est retourné.

[in] PreferredMaximum

Spécifie le nombre maximal d’octets d’éléments 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é.

Pour récupérer tous les éléments clients de sous-réseau pour la classe d’utilisateur et de fournisseur par défaut au niveau spécifié, définissez ce paramètre sur 0xFFFFFFFF.

[out] EnumElementInfo

Pointeur vers une structure DHCP_SUBNET_ELEMENT_INFO_ARRAY_V5 contenant une liste énumérée de tous les éléments disponibles pour le sous-réseau spécifié. Si aucun élément n’est disponible pour l’énumération, cette valeur est null.

[out] ElementsRead

Pointeur vers une valeur DWORD qui spécifie le nombre d’éléments de sous-réseau retournés dans EnumElementInfo.

[out] ElementsTotal

Pointeur vers une valeur DWORD qui spécifie le nombre total d’éléments pour le sous-réseau spécifié.

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. Les erreurs courantes sont les suivantes :

Code de retour Description
ERROR_INVALID_PARAMETER
 Cette erreur peut être retournée lorsque cette fonction est appelée avec EnumElementType défini sur DhcpIpRangesDhcpOnly ou DhcpIpRangesDhcpBootp.
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.

Remarques

Lorsque vous n’en avez plus besoin, les ressources consommées pour les données énumérées et tous les pointeurs contenus dans doivent être libérés avec DhcpRpcFreeMemory.

Configuration requise

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

Voir aussi

DHCP_SUBNET_ELEMENT_INFO_ARRAY_V5

DHCP_SUBNET_ELEMENT_TYPE