Fonction DhcpEnumSubnetElementsV6 (dhcpsapi.h)

  • Article

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

Syntaxe

DWORD DHCP_API_FUNCTION DhcpEnumSubnetElementsV6(
  [in]      LPWSTR                              ServerIpAddress,
  [in]      DHCP_IPV6_ADDRESS                   SubnetAddress,
  [in]      DHCP_SUBNET_ELEMENT_TYPE_V6         EnumElementType,
  [in, out] DHCP_RESUME_HANDLE                  *ResumeHandle,
  [in]      DWORD                               PreferredMaximum,
  [out]     LPDHCP_SUBNET_ELEMENT_INFO_ARRAY_V6 *EnumElementInfo,
  [out]     DWORD                               *ElementsRead,
  [out]     DWORD                               *ElementsTotal
);

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 qui spécifie le sous-réseau dont les éléments seront énumérés.

[in] EnumElementType

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

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

[out] EnumElementInfo

Pointeur vers une structure de DHCP_SUBNET_ELEMENT_INFO_ARRAY_V6 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.

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