Freigeben über


RtmDequeueRouteChangeMessage-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 RtmDequeueRouteChangeMessage-Funktion gibt die nächste Routenänderungsmeldung in der Warteschlange zurück, die dem angegebenen Client zugeordnet ist.

Syntax

DWORD RtmDequeueRouteChangeMessage(
  _In_  HANDLE ClientHandle,
  _Out_ DWORD  Flags,
  _Out_ PVOID  CurBestRoute,
  _Out_ PVOID  PrevBestRoute
);

Parameter

ClientHandle [in]

Handle, das den Client identifiziert, für den der Vorgang ausgeführt wird. Rufen Sie dieses Handle ab, indem Sie RtmRegisterClient aufrufen.

Flags [out]

Zeiger auf eine DWORD-Variable . Der Wert dieser Variablen wird vom Routingtabellen-Manager festgelegt. Der -Wert gibt den Typ der Änderungsmeldung an und welche Informationen in den bereitgestellten Puffern zurückgegeben wurden. Bei diesem Parameter handelt es sich um einen der folgenden Parameter.

Flags Bedeutung
RTM_ROUTE_ADDED
Die erste Route wurde für ein bestimmtes Zielnetzwerk hinzugefügt. Der CurBestRoute-Parameter verweist auf die Informationen für die hinzugefügte Route.
RTM_ROUTE_DELETED
Die einzige für ein bestimmtes Zielnetzwerk verfügbare Route wurde gelöscht. Der Parameter PrevBestRoute verweist auf die Informationen für die gelöschte Route.
RTM_ROUTE_CHANGED
Mindestens einer der wichtigen Parameter wurde für eine optimale Route zu einem bestimmten Zielnetzwerk geändert. Die wichtigsten Parameter sind:
Protokollbezeichner
Schnittstellenindex
Adresse des nächsten Hops
Protokollfamilienspezifische Daten (einschließlich Routenmetriken)

Der Parameter PrevBestRoute verweist auf die Routeninformationen, wie sie vor der Änderung waren. Der CurBestRoute-Parameter verweist auf aktuelle (d. h. nach der Änderung) Routeninformationen.

CurBestRoute [out]

Zeiger auf eine Struktur, die die aktuellen Informationen zur besten Route empfängt (falls vorhanden). Der Typ der Struktur ist spezifisch für die Protokollfamilie, z. B. IP oder IPX.

Dieser Parameter ist optional. Wenn der Aufrufer NULL für diesen Parameter angibt, werden die aktuellen Informationen zur besten Route nicht zurückgegeben.

PrevBestRoute [out]

Zeiger auf eine Struktur, die ggf. die vorherigen Bestrouteninformationen empfängt. Der Typ der Struktur ist spezifisch für die Protokollfamilie, z. B. IP oder IPX.

Dieser Parameter ist optional. Wenn der Aufrufer NULL für diesen Parameter angibt, werden die vorherigen Bestrouteninformationen nicht zurückgegeben.

Rückgabewert

Der Rückgabewert ist einer der folgenden Codes.

Wert Beschreibung
NO_ERROR
Diese Meldung war die letzte Nachricht in der Warteschlange des Clients. Das Ereignisobjekt wird zurückgesetzt.
ERROR_INVALID_HANDLE
Der ClientHandle-Parameter ist kein gültiges Handle, oder der Client hat bei der Registrierung kein Ereignisobjekt für die Änderungsmeldungsbenachrichtigung bereitgestellt (siehe RtmRegisterClient).
ERROR_MORE_MESSAGES
Die Warteschlange des Clients enthält zusätzliche Nachrichten. Der Client sollte RtmDequeueRouteChangeMessage so bald wie möglich erneut aufrufen, damit der Routingtabellen-Manager die Ressourcen freigeben kann, die den ausstehenden Nachrichten zugeordnet sind.
ERROR_NO_MESSAGES
Die Warteschlange des Clients enthält keine Nachrichten. der Anruf wurde nicht angefordert. Das Ereignis wird zurückgesetzt.
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

RtmRegisterClient