IMsRdpClient::RequestClose メソッド

リモート デスクトップ ActiveX コントロールの正常なシャットダウンを要求します。 正常なシャットダウンには、ユーザーのリモート デスクトップ サービス セッションの終了を含めることができますが、リモート デスクトップ セッション ホスト (RD セッション ホスト) サーバーはシャットダウンされません。

構文

HRESULT RequestClose(
  [out] ControlCloseStatus *pCloseStatus
);

パラメーター

pCloseStatus [out]

アプリケーションがコントロールを直ちに閉じることができるかどうかを示す ControlCloseStatus 列挙の値。 使用可能な値の一覧を次に示します。

controlCloseCanProceed (0x0000)

コンテナー アプリケーションは、すぐにコントロールを閉じ続けることができます。 この値は、接続が既に終了したことを示すこともできます。

controlCloseWaitForEvents (0x0001)

コンテナー アプリケーションは、コントロールを直ちに閉じてはいけません。アプリケーションは、閉じる前に、次の「備考」セクションで説明されているいずれかのイベントが発生するまで待機する必要があります。

戻り値

成功 した場合は、S_OK を返します。

解説

pCloseStatus パラメーターが controlCloseWaitForEvents と等しい場合、アプリケーションは、アプリケーションがコントロールを閉じる前に、次のいずれかのイベントが発生するまで待機する必要があります。

  • IMsTscAxEvents::OnDisconnected。 ユーザーがリモート デスクトップ サービス セッションにログオンしていない場合、アプリケーションは DestroyWindow 関数を呼び出してすべてのウィンドウを破棄し、コントロールを閉じます。
  • IMsTscAxEvents::OnConfirmClose。 ユーザーがリモート デスクトップ サービス セッションにログオンしている場合、コントロールは OnConfirmClose イベントを発生させます。 このイベントにより、アプリケーションは接続を閉じるかどうかをユーザーに確認できます。 ユーザーがプロンプトに [はい] と応答した場合、コンテナー アプリケーションは DestroyWindow を呼び出してすべてのウィンドウを破棄し、コントロールを閉じます。

RequestClose を使用すると、コンテナー アプリケーションは接続を閉じるかどうかをユーザーに確認できます。 詳細については、「 IMsTscAxEvents::OnConfirmClose」を参照してください

リモート デスクトップ Web 接続の詳細については、「 リモート デスクトップ Web 接続の要件」を参照してください。

必要条件

要件
サポートされている最小のクライアント
Windows Vista
サポートされている最小のサーバー
Windows Server 2008
タイプ ライブラリ
MsTscAx.dll
[DLL]
MsTscAx.dll
IID
IID_IMsRdpClientは 92b4a539-7115-4b7c-a5a9-e5d9efc2780a として定義されています

関連項目

IMsRdpClient

IMsRdpClient2

IMsRdpClient3

IMsRdpClient4

IMsRdpClient5

IMsRdpClient6

IMsRdpClient7

IMsRdpClient8

IMsRdpClient9

IMsRdpClient10

IMsTscAxEvents::OnConfirmClose

IMsTscAxEvents::OnDisconnected