WTSVirtualChannelOpen-Funktion (wtsapi32.h)

  • Artikel

Öffnet ein Handle am Serverende eines angegebenen virtuellen Kanals.

Diese Funktion ist veraltet. Verwenden Sie stattdessen die Funktion WTSVirtualChannelOpenEx .

Syntax

HANDLE WTSVirtualChannelOpen(
  [in] HANDLE hServer,
  [in] DWORD  SessionId,
  [in] LPSTR  pVirtualName
);

Parameter

[in] hServer

Dieser Parameter muss WTS_CURRENT_SERVER_HANDLE sein.

[in] SessionId

Ein Remotedesktopdienste-Sitzungsbezeichner. Um die aktuelle Sitzung anzugeben, geben Sie WTS_CURRENT_SESSION an. Sie können die FUNKTION WTSEnumerateSessions verwenden, um die Bezeichner aller Sitzungen auf einem angegebenen RD-Sitzungshostserver abzurufen.

Um einen virtuellen Kanal in der Sitzung eines anderen Benutzers zu öffnen, benötigen Sie die Berechtigung des virtuellen Kanals. Weitere Informationen finden Sie unter Berechtigungen für Remotedesktopdienste. Um Berechtigungen für eine Sitzung zu ändern, verwenden Sie das Verwaltungstool Remotedesktopdienste-Konfiguration.

[in] pVirtualName

Ein Zeiger auf eine NULL-endende Zeichenfolge, die den Namen des virtuellen Kanals enthält. Beachten Sie, dass dies eine ANSI-Zeichenfolge ist, auch wenn UNICODE definiert ist. Der Name des virtuellen Kanals besteht aus einem bis CHANNEL_NAME_LEN Zeichen, ohne dass das endende NULL-Zeichen enthalten ist.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Handle für den angegebenen virtuellen Kanal.

Wenn bei der Funktion ein Fehler auftritt, ist der Rückgabewert NULL. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Wenn Sie die Verwendung des Handles abgeschlossen haben, geben Sie es frei, indem Sie die Funktion WTSVirtualChannelClose aufrufen.

Ein Beispiel, das zeigt, wie Sie Zugriff auf ein Virtuelles Kanaldateihandle erhalten, das für asynchrone E/A-Vorgänge verwendet werden kann, finden Sie unter WTSVirtualChannelQuery.

Wenn Sie versuchen, diese Funktion zu verwenden, um denselben virtuellen Kanal mehrmals zu öffnen, kann dies zu einer Verzögerung von 10 Sekunden führen und den eingerichteten Kanal unterbrechen.

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

WTSOpenServer

WTSVirtualChannelClose