Fonction RtmEnumerateGetNextRoute

[Cette API a été remplacée par l’API Gestionnaire de tables de routage version 2 et ne sera pas disponible au-delà de Windows Server 2003. Les applications doivent utiliser l’API Routing Table Manager Version 2.]

La fonction RtmEnumerateGetNextRoute retourne l’entrée next-route dans l’énumération démarrée par un appel à RtmCreateEnumerationHandle.

Syntaxe

DWORD RtmEnumerateGetNextRoute(
  _In_  HANDLE EnumerationHandle,
  _Out_ PVOID  Route
);

Paramètres

EnumerationHandle [in]

Handle qui identifie l’énumération et spécifie son étendue. Obtenez ce handle en appelant RtmCreateEnumerationHandle.

Route [out]

Pointeur vers une structure d’itinéraire spécifique à la famille de protocoles ( RTM_IP_ROUTE ou RTM_IPX_ROUTE). Cette structure recevra l’itinéraire suivant dans l’énumération.

Valeur retournée

Si la fonction réussit, la valeur de retour est NO_ERROR.

Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants.

Valeur	Description
ERROR_INVALID_HANDLE	Le paramètre EnumerationHandle n’est pas valide.
ERROR_NO_MORE_ROUTES	Il n’y a plus d’itinéraires dans l’énumération.
ERROR_NO_SYSTEM_RESOURCES	Les ressources sont insuffisantes pour effectuer l’opération.

Notes

Bien que les itinéraires ne soient pas retournés dans un ordre particulier, chaque itinéraire de l’énumération n’est retourné qu’une seule fois.

Spécifications

Condition requise	Valeur
Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Fin de la prise en charge des serveurs	Windows Server 2003
En-tête	Rtm.h
Bibliothèque	Rtm.lib
DLL	Rtm.dll

Voir aussi

Informations de référence sur le gestionnaire de tables de routage version 1

Fonctions du gestionnaire de tables de routage version 1

RTM_IP_ROUTE

RTM_IPX_ROUTE

RtmCloseEnumerationHandle

RtmCreateEnumerationHandle