RtmGetListEnumRoutes-Funktion (rtmv2.h)

Die RtmGetListEnumRoutes-Funktion listet einen Satz von Routen in einer angegebenen Routenliste auf.

Syntax

DWORD RtmGetListEnumRoutes(
  [in]      RTM_ENTITY_HANDLE RtmRegHandle,
  [in]      RTM_ENUM_HANDLE   EnumHandle,
  [in, out] PUINT             NumRoutes,
  [out]     PRTM_ROUTE_HANDLE RouteHandles
);

Parameter

[in] RtmRegHandle

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

[in] EnumHandle

Handle mit der zu enumerierenden Routenliste.

[in, out] NumRoutes

NumRoutes ist bei der Eingabe ein Zeiger auf einen UINT-Wert, der die maximale Anzahl von Routen angibt, die von RouteHandles empfangen werden können.

Bei der Ausgabe empfängt NumRoutes die tatsächliche Anzahl von Routen, die von RouteHandles empfangen wurden.

[out] RouteHandles

Bei der Eingabe ist DestInfo ein Zeiger auf ein Array von RTM_DEST_INFO Strukturen.

Bei der Ausgabe wird DestInfo mit den angeforderten Zielinformationen gefüllt.

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

Rufen Sie diese Funktion wiederholt auf, um alle Routen abzurufen.

Es gibt keine weiteren Routen, die aufgelistet werden müssen, wenn der Routingtabellen-Manager null in NumRoutes zurückgibt.

Beispielcode mit dieser Funktion finden Sie unter Verwenden einer Client-Specific Routenliste.

Anforderungen

Weitere Informationen

RtmCreateRouteListEnum

RtmDeleteEnumHandle