WTSDisconnectSession 関数 (wtsapi32.h)
セッションを閉じずに、指定したリモート デスクトップ サービス セッションからログオン ユーザーを切断します。 その後、ユーザーが同じリモート デスクトップ セッション ホスト (RD セッション ホスト) サーバーにログオンすると、ユーザーは同じセッションに再接続されます。
構文
BOOL WTSDisconnectSession(
[in] HANDLE hServer,
[in] DWORD SessionId,
[in] BOOL bWait
);
パラメーター
[in] hServer
RD セッション ホスト サーバーへのハンドル。 WTSOpenServer 関数または WTSOpenServerEx 関数によって開かれたハンドルを指定するか、WTS_CURRENT_SERVER_HANDLEを指定して、アプリケーションが実行されている RD セッション ホスト サーバーを示します。
[in] SessionId
リモート デスクトップ サービスのセッション識別子。 現在のセッションを示すには、 WTS_CURRENT_SESSIONを指定します。 指定した RD セッション ホスト サーバー上のすべてのセッションの識別子を取得するには、 WTSEnumerateSessions 関数を 使用します。
別のユーザーのセッションを切断できるようにするには、切断アクセス許可が必要です。 詳細については、「 リモート デスクトップ サービスのアクセス許可」を参照してください。 セッションのアクセス許可を変更するには、リモート デスクトップ サービス構成管理ツールを使用します。
RD 仮想化ホスト サーバーでホストされている仮想マシンで実行されているセッションを切断するには、RD 仮想化ホスト サーバーの Administrators グループのメンバーである必要があります。
[in] bWait
操作が同期であるかどうかを示します。 操作が完了するのを待つ場合は TRUE 、直ちに 返すには FALSE を 指定します。
戻り値
関数が成功した場合、戻り値は 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で導入) |