WTSLogoffSession 関数 (wtsapi32.h)

指定したリモート デスクトップ サービス セッションをログオフします。

構文

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

パラメーター

[in] hServer

RD セッション ホスト サーバーへのハンドル。 WTSOpenServer または WTSOpenServerEx 関数によって開かれたハンドルを指定するか、アプリケーションが実行されている RD セッション ホスト サーバーを示すWTS_CURRENT_SERVER_HANDLEを指定します。

[in] SessionId

リモート デスクトップ サービスのセッション識別子。 現在のセッションを示すには、 WTS_CURRENT_SESSIONを指定します。 WTSEnumerateSessions 関数を使用して、指定された RD セッション ホスト サーバー上のすべてのセッションの識別子を取得できます。

別のユーザーのセッションからログオフできるようにするには、リセットアクセス許可が必要です。 詳細については、「 リモート デスクトップ サービスのアクセス許可」を参照してください。 セッションのアクセス許可を変更するには、リモート デスクトップ サービス構成管理ツールを使用します。

RD 仮想化ホスト サーバーでホストされている仮想マシンで実行されているセッションをログオフするには、RD 仮想化ホスト サーバーの Administrators グループのメンバーである必要があります。

[in] bWait

操作が同期であるかどうかを示します。

bWait が TRUE の場合、関数はセッションがログオフされたときに を返します。

bWait が FALSE の場合、関数は直ちにを返します。 セッションがログオフされたことを確認するには、 WTSQuerySessionInformation 関数の呼び出しでセッション識別子を指定します。 WTSQuerySessionInformation は、セッションがログオフされた場合に 0 を返します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

要件

要件	値
サポートされている最小のクライアント	Windows Vista
サポートされている最小のサーバー	Windows Server 2008
対象プラットフォーム	Windows
ヘッダー	wtsapi32.h
Library	Wtsapi32.lib
[DLL]	Wtsapi32.dll
API セット	ext-ms-win-session-wtsapi32-l1-1-0 (Windows 8で導入)

こちらもご覧ください

WTSEnumerateSessions

WTSQuerySessionInformation