Fonction RtmGetFirstRoute

[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 RtmGetFirstRoute retourne le premier itinéraire à partir du sous-ensemble spécifié d’itinéraires dans la table.

Syntaxe

DWORD RtmGetFirstRoute(
  _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.

EnumerationFlags [in]

Spécifie les limites du jeu d’itinéraires supprimés à un sous-ensemble défini par ces indicateurs et aux valeurs dans les membres correspondants de la structure pointées par le paramètre CriteriaRoute . Les indicateurs sont les mêmes que ceux utilisés dans RtmCreateEnumerationHandle.

Route [in, out]

Lors de l’entrée, Route pointe vers une structure spécifique à la famille de protocole ( RTM_IP_ROUTE ou RTM_IPX_ROUTE).

La fonction appelante fournit des valeurs de membre pour cette structure. Ces valeurs, conjointement avec le paramètre EnumerationFlags , spécifient le jeu à partir duquel retourner les itinéraires.

Sortie, Route pointe vers la première route 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	Il n’existe aucun itinéraire qui 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 la fonction de handle d’énumération correspondante, RtmEnumerateGetNextRoute.

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

RtmCloseEnumerationHandle

RtmCreateEnumerationHandle

RtmEnumerateGetNextRoute

RtmGetNextRoute