RtmRegisterClient-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 RtmRegisterClient-Funktion registriert einen Client als Handler des angegebenen Protokolls. Sie richtet einen Benachrichtigungsmechanismus für Routenänderungen für den Client ein und legt Protokolloptionen fest.

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 mit dem identisch ist, der beim Registrieren beim Router-Manager verwendet wurde. Siehe RegisterProtocol.

ChangeEvent [ In]

Gibt an, dass sich eine beste Route zu einem Netzwerk in der Tabelle geändert hat. Der Routingtabellen-Manager signalisiert dieses Ereignis nach einer Änderung an der besten Route zu einem beliebigen 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 im besten Routenstatus.

Flags [ In]

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

Flags Bedeutung
_RTM-PROTOKOLL _ – EINZELNE _ 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 in 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 des Fehlers abzurufen.

Wert BESCHREIBUNG
FEHLER: _ CLIENT _ IST BEREITS _ VORHANDEN
Ein anderer Client hat sich bereits registriert, um das angegebene Protokoll zu verarbeiten.
FEHLER: _ UNGÜLTIGER _ PARAMETER
Die angegebene Protokollfamilie wird nicht unterstützt, oder der Flags-Parameter ist ungültig.
FEHLER _ KEINE _ _ SYSTEMRESSOURCEN
Unzureichende Ressourcen zum Ausführen des Vorgangs.
FEHLER _ NICHT _ GENÜGEND _ ARBEITSSPEICHER
Nicht genügend 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

Weitere Informationen

Referenz zu Routingtabellen-Manager, Version 1

Funktionen des Routingtabellen-Managers, Version 1

Getlasterror

RegisterProtocol

RTMv1-Protokollfamilienbezeichner

RtmDequeueRouteChangeMessage

RtmDeregisterClient