Fonction RtmGetNextRoute

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

La fonction RtmGetNextRoute retourne l’itinéraire suivant à partir du sous-ensemble spécifié d’itinéraires dans la table.

Syntaxe

DWORD RtmGetNextRoute(
  _In_    DWORD ProtocolFamily,
  _In_    DWORD EnumerationFlags,
  _Inout_ PVOID Route
);

Paramètres

ProtocolFamily [in]

Spécifie la famille de protocoles d’itinéraires à récupérer, par exemple, IP ou IPX.

ÉnumérationFlags [in]

Spécifie les itinéraires à énumérer. Ce paramètre limite l’ensemble d’itinéraires supprimés à un sous-ensemble défini par les indicateurs suivants et les valeurs dans les membres correspondants de la structure vers laquelle pointe le paramètre CriteriaRoute . Les indicateurs sont les mêmes que ceux utilisés dans RtmCreateEnumerationHandle.

Router [in, out]

En entrée, Route pointe vers une structure spécifique à la famille de protocoles ( RTM_IP_ROUTE ou RTM_IPX_ROUTE).

La fonction appelante fournit des valeurs membres pour cette structure. Ces valeurs, conjointement avec le paramètre ÉnumérationFlags , spécifient l’ensemble à partir duquel retourner des itinéraires.

Sur la sortie, Route pointe vers une structure qui reçoit le premier itinéraire correspondant aux critères spécifiés.

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_PARAMETER	L’un des paramètres n’est pas valide.
ERROR_NO_ROUTES	Aucun itinéraire ne correspond aux critères spécifiés.
ERROR_NO_SYSTEM_RESOURCES	Les ressources sont insuffisantes pour effectuer l’opération.

Notes

Les itinéraires sont retournés dans l’ordre suivant :

1. Numéro de réseau
2. Protocole de routage
3. Identificateur d’interface
4. Adresse du tronçon suivant

Cette fonction est moins efficace que les fonctions de handle d’énumération correspondantes.

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 routage de la version 1 du Gestionnaire de table

Fonctions du Gestionnaire de table de routage version 1

RtmCloseEnumerationHandle

RtmCreateEnumerationHandle

RtmEnumerateGetNextRoute

RtmGetFirstRoute