Freigeben über


RtmGetNextRoute-Funktion

[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 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 der abzurufenden Routen an, z. B. IP oder IPX.

EnumerationFlags [in]

Gibt an, welche Routen aufgelistet werden sollen. Dieser Parameter beschränkt den Satz gelöschter Routen auf eine Teilmenge, die durch die folgenden Flags und die Werte in den entsprechenden Membern der Struktur definiert wird, 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 eine Struktur, die die erste Route empfängt, 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
ERROR_INVALID_PARAMETER
Einer der Parameter ist ungültig.
ERROR_NO_ROUTES
Es gibt keine Routen, die den angegebenen Kriterien entsprechen.
ERROR_NO_SYSTEM_RESOURCES
Es gibt nicht genügend Ressourcen, um den Vorgang auszuführen.

Bemerkungen

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 Enumerationshandlefunktionen.

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

Referenz zu Routingtabellen-Manager, Version 1

Routingtabellen-Manager- Version 1-Funktionen

RtmCloseEnumerationHandle

RtmCreateEnumerationHandle

RtmEnumerateGetNextRoute

RtmGetFirstRoute