RtmCreateEnumerationHandle-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 RtmCreateEnumerationHandle-Funktion gibt ein Handle zurück, das mit RtmEnumerateGetNextRoute verwendet werden soll, um alle Routen oder eine Teilmenge von Routen zu durchsuchen, die dem Routingtabellen-Manager bekannt sind.

Syntax

HANDLE RtmCreateEnumerationHandle(
  _In_ DWORD ProtocolFamily,
  _In_ DWORD EnumerationFlags,
  _In_ PVOID CriteriaRoute
);

Parameter

ProtocolFamily [in]

Gibt die Protokollfamilie der zu enumerierenden Routen an.

EnumerationFlags [in]

Gibt an, welche Routen aufgelistet werden sollen. Dieser Parameter beschränkt den Satz von Routen, die von der Enumerations-API zurückgegeben werden, auf eine Teilmenge, die durch die folgenden Flags und die Werte in den entsprechenden Membern der Struktur definiert wird, auf die der CriteriaRoute-Parameter verweist. Dieser Parameter kann einen der folgenden Werte annehmen.

EnumerationFlags	Bedeutung
RTM_ONLY_THIS_NETWORK	Enumerieren Sie nur die Routen, die die gleiche Netzwerknummer wie der RR_Network Member der Struktur aufweisen, auf die von CriteriaRoute verwiesen wird.
RTM_ONLY_THIS_INTERFACE	Listet nur die Routen auf, die über die Schnittstelle abgerufen wurden, die im feld RR_InterfaceID der Struktur angegeben wurde, auf die von CriteriaRoute verwiesen wird.
RTM_ONLY_THIS_PROTOCOL	Listet nur die Routen auf, die vom Routingprotokoll hinzugefügt wurden, das im feld RR_RoutingProtocol der Struktur angegeben ist, auf die von CriteriaRoute verwiesen wird.
RTM_ONLY_BEST_ROUTES	Listet nur die besten Routen zu jedem der Netzwerke in der Gruppe auf.

CriteriaRoute [in]

Zeiger auf eine protokollfamilienspezifische Routenstruktur (RTM_IP_ROUTE oder RTM_IPX_ROUTE). Die Memberwerte in dieser Struktur entsprechen den Flags, die vom EnumerationFlags-Parameter angegeben werden.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein HANDLE , der mit nachfolgenden Enumerationsaufrufen verwendet werden soll.

Wenn die Funktion fehlschlägt oder keine Routen mit den angegebenen Kriterien vorhanden sind, ist der Rückgabewert NULL. Rufen Sie GetLastError auf, um weitere Informationen zu erhalten.

Anforderungen

Siehe auch

Referenz zu Routingtabellen-Manager, Version 1

Routingtabellen-Manager- Version 1-Funktionen

Getlasterror

RTM_IP_ROUTE

RTM_IPX_ROUTE

RtmCloseEnumerationHandle

RtmEnumerateGetNextRoute