Fonction DhcpEnumSubnets (dhcpsapi.h)

  • Article

La fonction DhcpEnumSubnets retourne une liste énumérée de sous-réseaux définis sur le serveur DHCP.

Syntaxe

DWORD DHCP_API_FUNCTION DhcpEnumSubnets(
  [in]      DHCP_CONST WCHAR   *ServerIpAddress,
  [in, out] DHCP_RESUME_HANDLE *ResumeHandle,
  [in]      DWORD              PreferredMaximum,
  [out]     LPDHCP_IP_ARRAY    *EnumInfo,
  [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, 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 et que 200 adresses de sous-réseau sont stockées sur le serveur, le handle de reprise d’activité peut être utilisé après la récupération des 100 premiers sous-réseaux pour obtenir les 100 suivants lors d’un appel suivant, et ainsi de suite.

[in] PreferredMaximum

Spécifie le nombre maximal d’adresses de sous-réseau par défaut à retourner. Si le nombre d’options non chiffrées restantes est inférieur à cette valeur, ce montant est retourné.

[out] EnumInfo

Pointeur vers une structure DHCP_IP_ARRAY qui contient les ID de sous-réseau disponibles sur le serveur DHCP. Si aucun sous-réseau n’est défini, cette valeur est null.

[out] ElementsRead

Pointeur vers une valeur DWORD qui spécifie le nombre d’adresses de sous-réseau retournées dans EnumInfo.

[out] ElementsTotal

Pointeur vers une valeur DWORD qui spécifie le nombre de sous-réseaux définis sur le serveur DHCP qui n’ont pas encore été énumérés.

Valeur retournée

Cette fonction retourne ERROR_SUCCESS en cas d’appel réussi. Si un appel est effectué avec la même valeur ResumeHandle et que tous les éléments du serveur ont été énumérés, cette méthode retourne ERROR_NO_MORE_ITEMS avec ElementsRead et ElementsTotal définis sur 0. Sinon, il retourne l’un des codes d’erreur de l’API gestion du serveur DHCP.

Notes

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.

Cette fonction nécessite l’ordre des octets de l’hôte pour toutes les valeurs DHCP_IP_ADDRESS dans les structures de paramètres.

Spécifications

   
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_IP_ARRAY