RtmGetFirstRoute fonction)
[cette api a été remplacée par l’api du gestionnaire de Table de routage Version 2 et ne sera pas disponible au-delà de Windows Server 2003. Les applications doivent utiliser l’API du gestionnaire de table de routage version 2.]
La fonction RtmGetFirstRoute retourne le premier itinéraire 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 [ dans]
-
Spécifie la famille de protocoles d’itinéraires à récupérer, par exemple, IP ou IPX.
-
EnumerationFlags [ dans]
-
Spécifie que limite le jeu d’itinéraires supprimés à un sous-ensemble défini par ces indicateurs et les valeurs des membres correspondants de la structure vers laquelle pointe le paramètre CriteriaRoute . Les indicateurs sont les mêmes que ceux utilisés dans RtmCreateEnumerationHandle.
-
Itinéraire [ in, out]
-
En entrée, l' itinéraire pointe vers une structure spécifique à la famille de protocoles ( _ _ itinéraire IP RTM ou _ _ itinéraire IPX RTM).
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 les itinéraires doivent être retournés.
Sortie de sortie, itinéraire pointe vers le premier itinéraire correspondant aux critères spécifiés.
Valeur retournée
Si la fonction est réussie, la valeur de retour n’est pas une _ erreur.
Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants.
| Valeur | Description |
|---|---|
|
L’un des paramètres n’est pas valide. |
|
Aucun itinéraire ne correspond aux critères spécifiés. |
|
Les ressources sont insuffisantes pour effectuer l’opération. |
Remarques
Les itinéraires sont retournés dans l’ordre suivant :
- Numéro de réseau
- Protocole de routage
- Identificateur d’interface
- Adresse du tronçon suivant
Cette fonction est moins efficace que la fonction de handle d’énumération correspondante, RtmEnumerateGetNextRoute.
Configuration requise
| 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 |
|
| Bibliothèque |
|
| DLL |
|