RtmGetEnumDests-Funktion (rtmv2.h)
Die RtmGetEnumDests-Funktion ruft den nächsten Satz von Zielen in der angegebenen Enumeration ab.
Syntax
DWORD RtmGetEnumDests(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ENUM_HANDLE EnumHandle,
[in, out] PUINT NumDests,
[out] PRTM_DEST_INFO DestInfos
);
Parameter
[in] RtmRegHandle
Handle mit dem Client, der von einem vorherigen Aufruf von RtmRegisterEntity abgerufen wurde.
[in] EnumHandle
Handle mit der Zielaufzählung.
[in, out] NumDests
NumDests ist bei der Eingabe ein Zeiger auf einen UINT-Wert, der die maximale Anzahl von Zielen angibt, die von DestInfos empfangen werden können. Bei der Ausgabe empfängt NumDests die tatsächliche Anzahl von Zielen, die von DestInfos empfangen werden.
[out] DestInfos
Bei der Eingabe ist DestInfos ein Zeiger auf eine RTM_DEST_INFO-Struktur .
Bei der Ausgabe empfängt DestInfos ein Array von Handles für Ziele.
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 Zielen, die der Client mit einem Aufruf abrufen darf. |
|
Es gibt keine weiteren Ziele, die aufgelistet werden müssen. |
Hinweise
Die Struktur, auf die von DestInfos verwiesen wird, ist eine Struktur mit variabler Größe. Wenn der Client mehrere Ansichten mit TargetViews angibt, erhöht sich die Größe von DestInfos für jede Ansicht. Verwenden Sie das makro RTM_SIZE_OF_DEST_INFO , um zu bestimmen, wie groß eine DestInfos-Struktur zuzuordnen ist, bevor Sie diese Funktion aufrufen. Verwenden Sie den für TargetViews angegebenen Wert als Parameter zum RTM_SIZE_OF_DEST_INFO.
Wenn die Ziele nicht mehr erforderlich sind, geben Sie sie frei, indem Sie RtmReleaseDests aufrufen.
Beispielcode mit dieser Funktion finden Sie unter Enumerate All Destinations.
Anforderungen
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 |