WTSLogoffSession 函式 (wtsapi32.h)

  • 發行項

註銷指定的遠端桌面服務會話。

語法

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

參數

[in] hServer

RD 工作階段主機伺服器的句柄。 指定由 WTSOpenServer 或 WTSOpenServerEx 函式開啟的句柄，或指定WTS_CURRENT_SERVER_HANDLE來指出應用程式執行所在的 RD 會話主機伺服器。

[in] SessionId

遠端桌面服務會話標識碼。 若要指出目前的工作階段，請指定 WTS_CURRENT_SESSION。 您可以使用 WTSEnumerateSessions 函 式，擷取指定 RD 工作話主機伺服器上所有會話的標識碼。

若要能夠註銷另一位使用者的會話，您必須擁有重設許可權。 如需詳細資訊，請參閱 遠端桌面服務許可權。 若要修改會話的許可權，請使用遠端桌面服務組態系統管理工具。

若要註銷在裝載於 RD 虛擬化主機伺服器上的虛擬機上執行的工作階段，您必須是 RD 虛擬化主機伺服器上的 Administrators 群組成員。

[in] bWait

指出作業是否為同步。

如果 bWait 為 TRUE，則函式會在會話註銷時傳回。

如果 bWait 為 FALSE，函式會立即傳回。 若要確認會話已註銷，請在 對 WTSQuerySessionInformation 函式的呼叫中指定會話識別符。 如果會話已註銷，WTSQuerySessionInformation 會傳回零。

傳回值

如果函式成功，則傳回值是非零值。

如果此函式失敗，則傳回值為零。 若要取得擴充的錯誤資訊，請呼叫 GetLastError。

規格需求

需求 值
最低支援的用戶端 Windows Vista
最低支援的伺服器 Windows Server 2008
目標平台 Windows
標頭 wtsapi32.h
程式庫 Wtsapi32.lib
Dll Wtsapi32.dll
API 集合 ext-ms-win-session-wtsapi32-l1-1-0 (在 Windows 8) 中引進

另請參閱

WTSEnumerateSessions

WTSQuerySessionInformation