RtmRegisterClient-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 RtmRegisterClient-Funktion registriert einen Client als Handler des angegebenen Protokolls. Es wird ein Routenänderungsbenachrichtigungsmechanismus für den Client eingerichtet und Protokolloptionen festgelegt.

Syntax

HANDLE RtmRegisterClient(
  _In_ DWORD  ProtocolFamily,
  _In_ DWORD  RoutingProtocol,
  _In_ HANDLE ChangeEvent,
  _In_ DWORD  Flags
);

Parameter

ProtocolFamily [in]

Gibt die Protokollfamilie des zu registrierenden Routingprotokolls an.

RoutingProtocol [in]

Gibt den Routingprotokollbezeichner an, der bei der Registrierung beim Router-Manager verwendet wurde. Weitere Informationen finden Sie unter RegisterProtocol.

ChangeEvent [in]

Gibt an, dass sich die beste Route zu einem Netzwerk in der Tabelle geändert hat. Der Routingtabellen-Manager signalisiert dieses Ereignis nach einer Änderung der besten Route zu jedem Netzwerk in der Tabelle. Weitere Informationen zur Routenänderungsbenachrichtigung finden Sie unter RtmDequeueRouteChangeMessage .

Dieser Parameter ist optional. Wenn der Aufrufer NULL für diesen Parameter angibt, benachrichtigt der Routingtabellen-Manager den Client nicht über Änderungen an den besten Routen status.

Flaggen [in]

Gibt verschiedene Optionen für die spezielle Behandlung des Routingprotokolls an. Der folgende Wert wird derzeit unterstützt.

Flags Bedeutung
RTM_PROTOCOL_SINGLE_ROUTE
Der Routingtabellen-Manager behält nur eine Route pro Zielnetzwerk für das Routingprotokoll bei. Anders ausgedrückt: Der Routingtabellen-Manager ersetzt Routeneinträge, die die gleichen Zielnetzwerknummern aufweisen, anstatt neue hinzuzufügen.

Rückgabewert

Bei erfolgreicher Rückgabe ein HANDLE-Wert , der den Client bei nachfolgenden Aufrufen des Routingtabellen-Managers identifiziert.

Ein NULL-Handle gibt an, dass der Routingtabellen-Manager den Client nicht registrieren konnte. Rufen Sie GetLastError auf, um die Ursache für den Fehler abzurufen.

Wert Beschreibung
ERROR_CLIENT_ALREADY_EXISTS
Ein anderer Client hat sich bereits registriert, um das angegebene Protokoll zu verarbeiten.
ERROR_INVALID_PARAMETER
Die angegebene Protokollfamilie wird nicht unterstützt, oder der Flags-Parameter ist ungültig.
ERROR_NO_SYSTEM_RESOURCES
Unzureichende Ressourcen zum Ausführen des Vorgangs.
ERROR_NOT_ENOUGH_MEMORY
Unzureichender Arbeitsspeicher zum Zuordnen von Datenstrukturen für den Client.

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

RegisterProtocol

RTMv1-Protokollfamilienbezeichner

RtmDequeueRouteChangeMessage

RtmDeregisterClient