WTSEnumerateSessionsExA-Funktion (wtsapi32.h)
Ruft eine Liste von Sitzungen auf einem angegebenen Rd Desktop Session Host (RD Session Host) Server oder Remote Desktop Virtualization Host (RD Virtualization Host) Server ab.
Syntax
BOOL WTSEnumerateSessionsExA(
[in] HANDLE hServer,
[in, out] DWORD *pLevel,
[in] DWORD Filter,
[out] PWTS_SESSION_INFO_1A *ppSessionInfo,
[out] DWORD *pCount
);
Parameter
[in] hServer
Ein Handle für den Zielserver. Geben Sie ein Handle an, das von der WTSOpenServer- oder WTSOpenServerEx--Funktion zurückgegeben wird. Wenn Sie Sitzungen auf dem RD-Sitzungshostserver auflisten möchten, auf dem die Anwendung ausgeführt wird, geben Sie WTS_CURRENT_SERVER_HANDLEan.
[in, out] pLevel
Dieser Parameter ist reserviert. Legen Sie diesen Parameter immer auf einen parameter fest. Bei der Ausgabe ändert WTSEnumerateSessionsEx den Wert dieses Parameters nicht.
[in] Filter
Dieser Parameter ist reserviert. Legen Sie diesen Parameter immer auf Null fest.
[out] ppSessionInfo
Ein Zeiger auf eine PWTS_SESSION_INFO_1 Variable, die einen Zeiger auf ein Array von WTS_SESSION_INFO_1 Strukturen empfängt. Jede Struktur im Array enthält Informationen zu einer Sitzung auf dem angegebenen RD-Sitzungshostserver. Wenn Sie ein Handle für einen RD Virtualization Host-Server erhalten haben, indem Sie die WTSOpenServerEx--Funktion aufrufen, enthält das Array Informationen zu Sitzungen auf virtuellen Computern auf dem Server. Wenn Sie mit der Verwendung des Arrays fertig sind, geben Sie es frei, indem Sie die funktion WTSFreeMemoryEx aufrufen. Sie sollten auch den Zeiger auf NULL-festlegen.
[out] pCount
Ein Zeiger auf eine DWORD- Variable, die die Anzahl der im ppSessionInfo Puffer zurückgegebenen WTS_SESSION_INFO_1 Strukturen empfängt.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich Null.
Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie zum Abrufen erweiterter Fehlerinformationen die GetLastError--Funktion auf.
Bemerkungen
Um Informationen zu Sitzungen abzurufen, die auf virtuellen Computern auf einem RD Virtualization Host-Server ausgeführt werden, müssen Sie das Handle abrufen, indem Sie die WTSOpenServerEx--Funktion aufrufen. Rufen Sie zum Freigeben des zurückgegebenen Puffers die WTSFreeMemoryEx--Funktion auf, und legen Sie den WTSClassType Parameter auf WTSTypeSessionInfoLevel1fest.
Um eine Sitzung aufzählen zu können, müssen Sie über die Berechtigung "Abfrageinformationen" für diese Sitzung verfügen. Weitere Informationen finden Sie unter Berechtigungen für Remotedesktopdienste. Verwenden Sie das Verwaltungstool für remotedesktopdienste, um Berechtigungen für eine Sitzung zu ändern.
Um Sitzungen auf einem virtuellen Computer auflisten zu können, der auf einem RD Virtualization Host-Server gehostet wird, müssen Sie Mitglied der Gruppe "Administratoren" auf dem RD Virtualization Host-Server sein.
Anmerkung
Der wtsapi32.h-Header definiert WTSEnumerateSessionsEx als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.
Anforderungen
| Anforderung | Wert |
|---|---|
| mindestens unterstützte Client- | Windows 7 |
| mindestens unterstützte Server- | Windows Server 2008 R2 |
| Zielplattform- | Fenster |
| Header- | wtsapi32.h |
| Library | Wtsapi32.lib |
| DLL- | Wtsapi32.dll |
| API-Satz | ext-ms-win-session-wtsapi32-l1-1-0 (eingeführt in Windows 8) |