WTSEnumerateSessionsA-Funktion (wtsapi32.h)

Artikel
11/20/2024

Ruft eine Liste der Sitzungen auf einem Remotedesktopsitzungshostserver (RD-Sitzungshost) ab.

Syntax

BOOL WTSEnumerateSessionsA(
  [in]  HANDLE             hServer,
  [in]  DWORD              Reserved,
  [in]  DWORD              Version,
  [out] PWTS_SESSION_INFOA *ppSessionInfo,
  [out] DWORD              *pCount
);

Parameter

[in] hServer

Ein Handle für den RD-Sitzungshostserver.

Hinweis Sie können die WTSOpenServer oder WTSOpenServerEx- funktionen verwenden, um ein Handle für einen bestimmten Server abzurufen, oder WTS_CURRENT_SERVER_HANDLE, um den RD-Sitzungshostserver zu verwenden, der Ihre Anwendung hostet.

[in] Reserved

Dieser Parameter ist reserviert. Es muss null sein.

[in] Version

Die Version der Enumerationsanforderung. Dieser Parameter muss 1 sein.

[out] ppSessionInfo

Ein Zeiger auf ein Array von WTS_SESSION_INFO Strukturen, die die abgerufenen Sitzungen darstellen. Rufen Sie zum Freigeben des zurückgegebenen Puffers die WTSFreeMemory-Funktion auf.

Sitzungsberechtigungen:

Zum Aufzählen einer Sitzung müssen Sie die Berechtigung "Abfrageinformationen" aktivieren. Weitere Informationen finden Sie unter Berechtigungen für Remotedesktopdienste.
Um Berechtigungen für eine Sitzung zu ändern, verwenden Sie das Verwaltungstool für die Remotedesktopdienste-Konfiguration.
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.

[out] pCount

Ein Zeiger auf die Anzahl der im ppSessionInfo Parameter zurückgegebenen WTS_SESSION_INFO Strukturen.

Rückgabewert

Gibt Null zurück, wenn diese Funktion fehlschlägt. Wenn diese Funktion erfolgreich ist, wird ein Wert ungleich Null zurückgegeben.

Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.

Bemerkungen

Anmerkung

Der wtsapi32.h-Header definiert WTSEnumerateSessions 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 Vista
mindestens unterstützte Server-	Windows Server 2008
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)

Siehe auch

WTS_SESSION_INFO

Freigeben über