RtmGetRegisteredEntities-Funktion (rtmv2.h)

Die RtmGetRegisteredEntities-Funktion gibt Informationen zu allen Clients zurück, die sich mit dem angegebenen instance des Routingtabellen-Managers und der angegebenen Adressfamilie registriert haben.

Syntax

DWORD RtmGetRegisteredEntities(
  [in]      RTM_ENTITY_HANDLE  RtmRegHandle,
  [in, out] PUINT              NumEntities,
  [out]     PRTM_ENTITY_HANDLE EntityHandles,
  [out]     PRTM_ENTITY_INFO   EntityInfos
);

Parameter

[in] RtmRegHandle

Handle mit dem Client, der von einem vorherigen Aufruf von RtmRegisterEntity abgerufen wurde.

[in, out] NumEntities

NumEntities ist bei der Eingabe ein Zeiger auf einen UINT-Wert, der die maximale Anzahl von Clients angibt, die von EntityInfos empfangen werden können. Bei der Ausgabe erhält NumEntities die tatsächliche Anzahl von Clients, die von EntityInfos empfangen wurden.

[out] EntityHandles

Wenn Handles zurückgegeben werden müssen: Bei der Eingabe ist EntityHandles ein Zeiger auf NULL. Bei der Ausgabe empfängt EntityHandles einen Zeiger auf ein Array von Entitätshandle. Andernfalls bleibt EntityHandles unverändert.

Wenn Handles nicht zurückgegeben werden müssen: Bei der Eingabe ist EntityHandlesNULL.

[out] EntityInfos

Wenn ein Zeiger zurückgegeben werden muss: Bei der Eingabe ist EntityInfos ein Zeiger auf NULL. Bei der Ausgabe empfängt EntityInfos einen Zeiger auf ein Array von RTM_ENTITY_INFO Strukturen. Andernfalls bleibt EntityInfos unverändert.

Wenn kein Zeiger zurückgegeben werden muss: Bei der Eingabe ist EntityInfosNULL.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR.

Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.

Hinweise

Wenn ERROR_INSUFFICIENT_BUFFER zurückgegeben wird, sind möglicherweise einige Daten in EntityHandles vorhanden. Der NumEntities-Parameter gibt an, wie viele Entitäten tatsächlich zurückgegeben wurden.

Die RtmGetRegisteredEntities-Funktion kann von Routingprotokollen verwendet werden, um zu überprüfen, welche anderen Protokolle für diese Adressfamilie und den Routingtabellen-Manager instance ausgeführt werden. Basierend auf den zurückgegebenen Informationen kann ein Client dann protokollspezifische Verarbeitungen durchführen.

Die RTMv2-API unterstützt nur einen instance des Routingtabellen-Managers.

Wenn die Entitäten nicht mehr erforderlich sind, geben Sie sie frei, indem Sie RtmReleaseEntities aufrufen.

Beispielcode, der diese Funktion verwendet, finden Sie unter Aufzählen der registrierten Entitäten.

Anforderungen

Weitere Informationen

RTM_ENTITY_INFO

RtmReleaseEntities