WTSLogoffSession 函数 (wtsapi32.h)

注销指定的远程桌面服务会话。

语法

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

参数

[in] hServer

RD 会话主机服务器的句柄。 指定由 WTSOpenServerWTSOpenServerEx 函数打开的句柄,或指定 WTS_CURRENT_SERVER_HANDLE 以指示运行应用程序的 RD 会话主机服务器。

[in] SessionId

远程桌面服务会话标识符。 若要指示当前会话,请指定 WTS_CURRENT_SESSION。 可以使用 WTSEnumerateSessions 函数检索指定 RD 会话主机服务器上所有会话的标识符。

若要能够注销其他用户的会话,需要具有“重置”权限。 有关详细信息,请参阅 远程桌面服务权限。 若要修改会话的权限,请使用远程桌面服务配置管理工具。

若要注销在 RD 虚拟化主机服务器上托管的虚拟机上运行的会话,你必须是 RD 虚拟化主机服务器上的 Administrators 组的成员。

[in] bWait

指示操作是否同步。

如果 bWaitTRUE,则函数在注销会话时返回 。

如果 bWaitFALSE,则函数将立即返回。 若要验证会话是否已注销,请在调用 WTSQuerySessionInformation 函数时指定会话标识符。 如果会话已注销,则 WTSQuerySessionInformation 返回零。

返回值

如果函数成功,则返回值为非零值。

如果函数失败,则返回值为零。 要获得更多的错误信息,请调用 GetLastError。

要求

要求
最低受支持的客户端 Windows Vista
最低受支持的服务器 Windows Server 2008
目标平台 Windows
标头 wtsapi32.h
Library Wtsapi32.lib
DLL Wtsapi32.dll
API 集 在 Windows 8) 中引入的 ext-ms-win-session-wtsapi32-l1-1-0 (

另请参阅

WTSEnumerateSessions

WTSQuerySessionInformation