WTSEnumerateSessionsA-Funktion (wtsapi32.h)

  • Artikel

Ruft eine Liste der Sitzungen auf einem Remotedesktop-Sitzungshostserver (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 Funktionen WTSOpenServer oder WTSOpenServerEx 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 0 (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 die WTSFreeMemory-Funktion auf, um den zurückgegebenen Puffer freizugeben.

Sitzungsberechtigungen:

  • Um eine Sitzung aufzulisten, müssen Sie die Berechtigung für Abfrageinformationen aktivieren. Weitere Informationen finden Sie unter Berechtigungen für Remotedesktopdienste.
  • Um Berechtigungen für eine Sitzung zu ändern, verwenden Sie das Verwaltungstool Remotedesktopdienste-Konfiguration.
  • Um Sitzungen aufzulisten, die auf einem virtuellen Computer ausgeführt werden, der auf einem RD-Virtualisierungshostserver gehostet wird, müssen Sie Mitglied der Gruppe Administratoren auf dem RD-Virtualisierungshostserver sein.

[out] pCount

Ein Zeiger auf die Anzahl der WTS_SESSION_INFO Strukturen, die im ppSessionInfo-Parameter zurückgegeben werden.

Rückgabewert

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

Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Hinweis

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
Unterstützte Mindestversion (Client) Windows Vista
Unterstützte Mindestversion (Server) Windows Server 2008
Zielplattform Windows
Kopfzeile wtsapi32.h
Bibliothek Wtsapi32.lib
DLL Wtsapi32.dll
APIs ext-ms-win-session-wtsapi32-l1-1-0 (eingeführt in Windows 8)

Weitere Informationen

WTS_SESSION_INFO