Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
[Diese API wurde von der Routing Table Manager Version 2-API abgelöst und ist über Windows Server 2003 hinaus nicht verfügbar. Anwendungen sollten die Api für Routingtabellen-Manager Version 2 verwenden.]
Die RtmGetFirstRoute-Funktion gibt die erste Route aus der angegebenen Teilmenge der Routen in der Tabelle zurück.
Syntax
DWORD RtmGetFirstRoute(
_In_ DWORD ProtocolFamily,
_In_ DWORD EnumerationFlags,
_Inout_ PVOID Route
);
Parameter
-
ProtocolFamily [in]
-
Gibt die Protokollfamilie der abzurufenden Routen an, z. B. IP oder IPX.
-
EnumerationFlags [in]
-
Gibt an, dass den Satz gelöschter Routen auf eine Teilmenge beschränkt, die durch diese Flags definiert wird, und die Werte in den entsprechenden Membern der Struktur, auf die der CriteriaRoute-Parameter verweist. Die Flags sind identisch mit denen, die in RtmCreateEnumerationHandle verwendet werden.
-
Route [ein, ausgehend]
-
Bei der Eingabe verweist Route auf eine protokollfamilienspezifische Struktur ( RTM_IP_ROUTE oder RTM_IPX_ROUTE).
Die aufrufende Funktion stellt Memberwerte für diese Struktur bereit. Diese Werte geben in Verbindung mit dem EnumerationFlags-Parameter den Satz an, von dem Routen zurückgegeben werden sollen.
In der Ausgabe zeigt Route auf die erste Route, die den angegebenen Kriterien entspricht.
Rückgabewert
Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR.
Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.
| Wert | BESCHREIBUNG |
|---|---|
|
Einer der Parameter ist ungültig. |
|
Es gibt keine Routen, die den angegebenen Kriterien entsprechen. |
|
Es gibt nicht genügend Ressourcen, um den Vorgang auszuführen. |
Bemerkungen
Die Routen werden in der folgenden Reihenfolge zurückgegeben:
- Netzwerknummer
- Routingprotokoll
- Schnittstellen-ID
- Adresse des nächsten Hops
Diese Funktion ist weniger effizient als die entsprechende Enumerationshandlefunktion RtmEnumerateGetNextRoute.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) |
Nicht unterstützt |
| Unterstützte Mindestversion (Server) |
Windows 2000 Server [nur Desktop-Apps] |
| Ende des Supports (Server) |
Windows Server 2003 |
| Header |
|
| Bibliothek |
|
| DLL |
|