Auf Englisch lesen

Freigeben über


RtmIsRoute-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 RtmIsRoute-Funktion bestimmt, ob eine oder mehrere Routen zu einem angegebenen Zielnetzwerk vorhanden sind. Wenn ja, 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 die der Parameter Network verweist, 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 besten Routeninformationen empfängt.

Rückgabewert

Der Rückgabewert ist einer der folgenden Codes.

Wert Beschreibung
TRUE
Es ist mindestens eine Route zum angegebenen Netzwerk vorhanden. Die beste Route wird in der Struktur zurückgegeben, auf die der BestRoute-Parameter verweist.
FALSE
Es gibt keine Route zum angegebenen Netzwerk, oder der Vorgang ist fehlgeschlagen. Rufen Sie GetLastError auf, um weitere Informationen zu erhalten:
NO_ERROR
Der Vorgang war erfolgreich, es gibt jedoch keine Route zum angegebenen Netzwerk.
ERROR_INVALID_PARAMETER
Der Wert des ProtocolFamily-Parameters entspricht keiner installierten Protokollfamilie.
ERROR_NO_SYSTEM_RESOURCES
Es gibt nicht genügend Ressourcen, 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

Routingtabellen-Manager- Version 1-Funktionen

Getlasterror

IP_NETWORK

IPX_NETWORK

RTMv1-Protokollfamilienbezeichner