Win32 API 日本語リファレンス
ホーム › System.RemoteDesktop › ITsSbBaseNotifySink

ITsSbBaseNotifySink

COM
📘 Microsoft Learn (日本語) · English
IID808a6537-1282-4989-9e09-f43938b71722継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

Remote Desktop Connection Broker (RD Connection Broker) にステータスおよびエラーメッセージを報告するメソッドを公開します。

解説(Remarks)

プラグインは、このインターフェイスを使用して RD Connection Broker にステータスおよびエラーメッセージを報告できます。

RD Connection Broker サーバーおよび Remote Desktop Session Host (RD Session Host) サーバー (リダイレクター) は Windows Server 2008 R2 を実行している必要があり、クライアントは RDC 7.0 を使用する必要があります。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT OnError(HRESULT hrError)

Remote Desktop Connection Broker (RD Connection Broker) にエラー状態を報告します。

hrErrorHRESULTinエラー状態。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドを呼び出すと、クライアント接続のそれ以降の処理が停止し、接続が失敗します。

vtbl 4 HRESULT OnReportStatus(CLIENT_MESSAGE_TYPE messageType, DWORD messageID)

クライアント接続の処理に関するステータスメッセージを Remote Desktop Connection (RDC) クライアントに送信します。

messageTypeCLIENT_MESSAGE_TYPEin

メッセージの種類。このパラメーターは次のいずれかの値である必要があります。

CLIENT_MESSAGE_CONNECTION_STATUS

ステータスメッセージ。

CLIENT_MESSAGE_CONNECTION_ERROR

エラーメッセージ。

messageIDDWORDin

メッセージ ID。このパラメーターは次のいずれかの値である必要があります。

TS_STATUS_VM_LOADING

仮想マシンを読み込んでいます。

TS_STATUS_VM_WAKING

仮想マシンを再開しています。

TS_STATUS_VM_BOOTING

仮想マシンを起動しています。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドを使用すると、プラグインはより具体的なステータスおよびエラーメッセージを RDC クライアントに送信でき、Remote Desktop Connection Broker (RD Connection Broker) がクライアントに送信する既定のステータスおよびエラーメッセージを上書きできます。

次のエラーコードは、プラグインが使用するために RD Connection Broker によって定義されています。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

#define global IID_ITsSbBaseNotifySink "{808A6537-1282-4989-9E09-F43938B71722}"
#usecom global ITsSbBaseNotifySink IID_ITsSbBaseNotifySink "{}"
#comfunc global ITsSbBaseNotifySink_OnError         3 int
#comfunc global ITsSbBaseNotifySink_OnReportStatus  4 int,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。