ホーム › System.RemoteDesktop › IWRdsProtocolShadowConnection

IWRdsProtocolShadowConnection

COM

IID9ae85ce6-cade-4548-8feb-99016597f60a継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

セッションのシャドウ処理の状態をプロトコルプロバイダーに通知するメソッドを公開します。

メソッド 3

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

vtbl 3 HRESULT Start(LPWSTR pTargetServerName, DWORD TargetSessionId, BYTE HotKeyVk, WORD HotkeyModifiers, IWRdsProtocolShadowCallback* pShadowCallback)

シャドウ処理が開始されたことをプロトコルに通知します。

pTargetServerName	LPWSTR	in	シャドウ処理を行うサーバーの名前を格納する文字列へのポインター。
TargetSessionId	DWORD	in	シャドウ対象となるセッションの ID を指定する整数。
HotKeyVk	BYTE	in	シャドウ処理を停止するために押す必要があるキーの仮想キーコード。このキーは HotkeyModifiers パラメーターと組み合わせて使用されます。
HotkeyModifiers	WORD	in	シャドウ処理を停止するために押す修飾キーを指定する仮想修飾子。修飾キーには Shift、Alt、Ctrl の各キーが含まれます。この修飾キーは HotKeyVk パラメーターで示されるキーと組み合わせて使用されます。
pShadowCallback	IWRdsProtocolShadowCallback*	in	リモートデスクトップサービスのサービスにコールバックするためにプロトコルが使用できる IWRdsProtocolShadowCallback インターフェイスへのポインター。

戻り値

このメソッドを実装する際は、関数が成功した場合は S_OK を返します。失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

解説(Remarks)

リモートデスクトップサービスのサービスは、シャドウ処理中であることを反映するために、シャドウ対象クライアントのセッション状態も変更します。

vtbl 4 HRESULT Stop()

シャドウ処理が停止したことをプロトコルに通知します。

戻り値

このメソッドを実装する際は、関数が成功した場合は S_OK を返します。失敗した場合は、エラーを示す HRESULT 値を返します。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。エラーが返された場合、リモートデスクトップサービスのサービスは接続を切断します。

解説(Remarks)

リモートデスクトップサービスのサービスは、シャドウ処理されていない状態になったことを反映するために、シャドウ対象クライアントのセッション状態も変更します。

vtbl 5 HRESULT DoTarget(BYTE* pParam1, DWORD Param1Size, BYTE* pParam2, DWORD Param2Size, BYTE* pParam3, DWORD Param3Size, BYTE* pParam4, DWORD Param4Size, LPWSTR pClientName)

シャドウ接続のターゲット側を開始するようプロトコルに要求します。

pParam1	BYTE*	in	任意のパラメーターを格納するバッファーへのポインター。
Param1Size	DWORD	in	pParam1 パラメーターが参照する値のサイズ(バイト単位)を格納する整数。
pParam2	BYTE*	in	任意のパラメーターを格納するバッファーへのポインター。
Param2Size	DWORD	in	pParam2 パラメーターが参照する値のサイズ(バイト単位)を格納する整数。
pParam3	BYTE*	in	任意のパラメーターを格納するバッファーへのポインター。
Param3Size	DWORD	in	pParam3 パラメーターが参照する値のサイズ(バイト単位)を格納する整数。
pParam4	BYTE*	in	任意のパラメーターを格納するバッファーへのポインター。
Param4Size	DWORD	in	pParam4 パラメーターが参照する値のサイズ(バイト単位)を格納する整数。
pClientName	LPWSTR	in	シャドウクライアントの名前を格納する文字列へのポインター。

戻り値

解説(Remarks)

4 つのパラメーター pParam1、pParam2、pParam3、pParam4 には、シャドウクライアントとシャドウターゲットの間でやり取りする必要のある任意の情報を格納できます。リモートデスクトップサービスのサービスは、この情報を変更せずにそのまま渡します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IWRdsProtocolShadowConnection "{9AE85CE6-CADE-4548-8FEB-99016597F60A}"
#usecom global IWRdsProtocolShadowConnection IID_IWRdsProtocolShadowConnection "{}"
#comfunc global IWRdsProtocolShadowConnection_Start     3 wstr,int,int,int,sptr
#comfunc global IWRdsProtocolShadowConnection_Stop      4
#comfunc global IWRdsProtocolShadowConnection_DoTarget  5 var,int,var,int,var,int,var,int,wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IWRdsProtocolShadowConnection "{9AE85CE6-CADE-4548-8FEB-99016597F60A}"
#usecom global IWRdsProtocolShadowConnection IID_IWRdsProtocolShadowConnection "{}"
#comfunc global IWRdsProtocolShadowConnection_Start     3 wstr,int,int,int,sptr
#comfunc global IWRdsProtocolShadowConnection_Stop      4
#comfunc global IWRdsProtocolShadowConnection_DoTarget  5 sptr,int,sptr,int,sptr,int,sptr,int,wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。