RtmIsRoute-Funktion

[Diese API wurde durch die Routing Table Manager Version 2-API ersetzt und ist nicht mehr als Windows Server 2003 verfügbar. Anwendungen sollten die Routing Table Manager Version 2-API verwenden.]

Die RtmIsRoute-Funktion bestimmt, ob eine oder mehrere Routen zu einem angegebenen Zielnetzwerk vorhanden sind. In diesem Falle gibt die Funktion Informationen für die beste Route zu diesem Netzwerk zurück.

Syntax

BOOL RtmIsRoute(
  _In_  DWORD ProtocolFamily,
  _In_  PVOID Network,
  _Out_ PVOID BestRoute
);

Parameter

ProtocolFamily [ In]

Gibt den Typ der Datenstruktur an, auf den der Network-Parameter zeigt, z. B. IP _ NETWORK, IPX _ NETWORK.

Netzwerk [ In]

Zeiger auf eine -Struktur, die protokollfamilienspezifische Netzwerknummerndaten angibt. Diese Daten identifizieren das Netzwerk, für das der Aufrufer Routeninformationen sucht.

BestRoute [ out]

Zeiger auf eine protokollfamilienspezifische Struktur, die ggf. die aktuellen Informationen zur besten Route empfängt.

Rückgabewert

Der Rückgabewert ist einer der folgenden Codes.

Wert Beschreibung
STIMMT
Mindestens eine Route zum angegebenen Netzwerk ist vorhanden. Die beste Route wird in der Struktur zurückgegeben, auf die der BestRoute-Parameter zeigt.
FALSE
Es gibt keine Route zum angegebenen Netzwerk, oder der Vorgang ist fehlgeschlagen. Rufen Sie GetLastError auf, um weitere Informationen zu erhalten:
KEIN _ FEHLER
Der Vorgang war erfolgreich, aber es gibt keine Route zum angegebenen Netzwerk.
FEHLER: _ UNGÜLTIGER _ PARAMETER
Der Wert des ProtocolFamily-Parameters entspricht keiner installierten Protokollfamilie.
FEHLER _ KEINE _ _ SYSTEMRESSOURCEN
Es sind nicht genügend Ressourcen vorhanden, um den Vorgang auszuführen.

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

Funktionen des Routingtabellen-Managers, Version 1

Getlasterror

_IP-NETZWERK

_IPX-NETZWERK

RTMv1-Protokollfamilienbezeichner