RtmGetNextRoute-Funktion

[Diese API wurde durch die RoutingTabellen-Manager-API Version 2 ersetzt und ist über Windows Server 2003 hinaus nicht mehr verfügbar. Anwendungen sollten die Routingtabellen-Manager-API Version 2 verwenden.]

Die RtmGetNextRoute-Funktion gibt die nächste Route aus der angegebenen Teilmenge der Routen in der Tabelle zurück.

Syntax

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

Parameter

ProtocolFamily [ In]

Gibt die Protokollfamilie von Routen an, die abgerufen werden soll, z. B. IP oder IPX.

EnumerationFlags [ In]

Gibt an, welche Routen aufzählt werden sollen. Dieser Parameter beschränkt den Satz gelöschter Routen auf eine Teilmenge, die durch die folgenden Flags definiert wird, und auf die Werte in den entsprechenden Membern der -Struktur, auf die der CriteriaRoute-Parameter zeigt. Die Flags sind identisch mit denen, die in RtmCreateEnumerationHandle verwendet werden.

Route [ in, out]

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 zur. Diese Werte geben in Verbindung mit dem EnumerationFlags-Parameter den Satz an, aus dem Routen zurückgibt.

Bei der Ausgabe zeigt Route auf eine -Struktur, die die erste Route empfängt, die den angegebenen Kriterien entspricht.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert NO _ ERROR.

Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.

Wert Beschreibung
FEHLER _ UNGÜLTIGER _ PARAMETER
Einer der Parameter ist ungültig.
FEHLER: _ KEINE _ ROUTEN
Es gibt keine Routen, die den angegebenen Kriterien entsprechen.
FEHLER: _ _ KEINE _ SYSTEMRESSOURCEN
Es sind nicht genügend Ressourcen zum Durchführen des Vorgangs verfügbar.

Hinweise

Die Routen werden in der folgenden Reihenfolge zurückgegeben:

  1. Netzwerknummer
  2. Routingprotokoll
  3. Schnittstellen-ID
  4. Adresse des nächsten Hops

Diese Funktion ist weniger effizient als die entsprechenden Enumerationshand handle-Funktionen.

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
Rtm.h
Bibliothek
Rtm.lib
DLL
Rtm.dll

Siehe auch

Routing Table Manager Version 1 Reference

Routingtabellen-Manager- Version 1-Funktionen

RtmCloseEnumerationHandle

RtmCreateEnumerationHandle

RtmEnumerateGetNextRoute

RtmGetFirstRoute