WTSDisconnectSession-Funktion (wtsapi32.h)

  • Artikel

Trennt den angemeldeten Benutzer von der angegebenen Remotedesktopdienste-Sitzung, ohne die Sitzung zu schließen. Wenn sich der Benutzer anschließend beimselben Remotedesktopsitzungshostserver (RD-Sitzungshost) anmeldet, wird der Benutzer wieder mit derselben Sitzung verbunden.

Syntax

BOOL WTSDisconnectSession(
  [in] HANDLE hServer,
  [in] DWORD  SessionId,
  [in] BOOL   bWait
);

Parameter

[in] hServer

Ein Handle für einen RD-Sitzungshostserver. Geben Sie ein Handle an, das von der FUNKTION WTSOpenServer oder WTSOpenServerEx geöffnet wird, oder geben Sie WTS_CURRENT_SERVER_HANDLE an, um den RD-Sitzungshostserver anzugeben, auf dem Ihre Anwendung ausgeführt wird.

[in] SessionId

Ein Remotedesktopdienste-Sitzungsbezeichner. Um die aktuelle Sitzung anzugeben, geben Sie WTS_CURRENT_SESSION an. Verwenden Sie die Funktion WTSEnumerateSessions , um die Bezeichner aller Sitzungen auf einem angegebenen RD-Sitzungshostserver abzurufen.

Um die Sitzung eines anderen Benutzers trennen zu können, benötigen Sie die Berechtigung Trennen. Weitere Informationen finden Sie unter Berechtigungen für Remotedesktopdienste. Um Berechtigungen für eine Sitzung zu ändern, verwenden Sie das Verwaltungstool Remotedesktopdienstekonfiguration.

Um Sitzungen zu trennen, 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.

[in] bWait

Gibt an, ob der Vorgang synchron ist. Geben Sie TRUE an, um auf den Abschluss des Vorgangs zu warten, oder false , um sofort zurückzugeben.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Nichtzero-Wert.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

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

WTSEnumerateSessions