RtmGetEnumRoutes-Funktion (rtmv2.h)
Die RtmGetEnumRoutes-Funktion ruft den nächsten Satz von Routen in der angegebenen Enumeration ab.
Syntax
DWORD RtmGetEnumRoutes(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ENUM_HANDLE EnumHandle,
[in, out] PUINT NumRoutes,
[out] PRTM_ROUTE_HANDLE RouteHandles
);
Parameter
[in] RtmRegHandle
Handle an den Client, der von einem vorherigen Aufruf von RtmRegisterEntity abgerufen wurde.
[in] EnumHandle
Handle für die Routenenumeration.
[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 werden.
[out] RouteHandles
Bei der Eingabe ist RouteHandles ein Zeiger auf eine RTM_ROUTE_INFO-Struktur .
Bei der Ausgabe empfängt RouteHandles ein Array von Handles für Routen.
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.
| Wert | Bedeutung |
|---|---|
|
Der Wert, auf den NumRoutes verweist, ist größer als die maximale Anzahl von Routen, die ein Client mit einem Aufruf abrufen darf. Überprüfen Sie RTM_REGN_PROFILE auf die maximale Anzahl von Routen, die der Client mit einem Aufruf abrufen darf. |
|
Es gibt keine weiteren Routen, die aufgelistet werden müssen. |
|
Es ist nicht genügend Arbeitsspeicher vorhanden, um diesen Vorgang abzuschließen. |
Hinweise
Wenn die Routen nicht mehr benötigt werden, geben Sie sie durch Aufrufen von RtmReleaseRoutes frei.
Beispielcode mit dieser Funktion finden Sie unter Auflisten aller Routen.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Nicht unterstützt |
| Unterstützte Mindestversion (Server) | Windows 2000 Server [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | rtmv2.h |
| Bibliothek | Rtm.lib |
| DLL | Rtm.dll |