ホーム › System.RemoteDesktop › IRemoteDesktopClient

IRemoteDesktopClient

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID57d25668-625a-4905-be4e-304caa13f89c継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

リモートデスクトッププロトコル (RDP) アプリコンテナークライアントコントロールを構成および使用するために使うメソッドとプロパティを提供します。

メソッド 10

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT Connect()

リモートデスクトッププロトコル (RDP) アプリコンテナークライアントコントロールに現在設定されているプロパティを使用して、接続を開始します。

戻り値

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

vtbl 8 HRESULT Disconnect()

アクティブな接続を切断します。

戻り値

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

vtbl 9 HRESULT Reconnect(DWORD width, DWORD height)

リモートデスクトッププロトコル (RDP) アプリコンテナークライアントコントロールの自動再接続を開始し、セッションを新しい幅と高さに合わせます。

width	DWORD	in	再接続後のセッション表示領域の幅をピクセル単位で指定する。
height	DWORD	in	再接続後のセッション表示領域の高さをピクセル単位で指定する。

戻り値

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

vtbl 10 HRESULT get_Settings(IRemoteDesktopClientSettings** settings)

リモートデスクトッププロトコル (RDP) アプリコンテナークライアントの設定オブジェクトを取得します。

settings

IRemoteDesktopClientSettings**

out

クライアント設定を扱う IRemoteDesktopClientSettings インターフェイスへのポインタを受け取る。

vtbl 11 HRESULT get_Actions(IRemoteDesktopClientActions** actions)

リモートデスクトッププロトコル (RDP) アプリコンテナークライアントのアクションオブジェクトを取得します。

actions

IRemoteDesktopClientActions**

out

クライアント操作を扱う IRemoteDesktopClientActions インターフェイスへのポインタを受け取る。

vtbl 12 HRESULT get_TouchPointer(IRemoteDesktopClientTouchPointer** touchPointer)

リモートデスクトッププロトコル (RDP) アプリコンテナークライアントの RemoteDesktopClientTouchPointer オブジェクトを格納します。

touchPointer

IRemoteDesktopClientTouchPointer**

out

タッチポインタを扱う IRemoteDesktopClientTouchPointer インターフェイスへのポインタを受け取る。

vtbl 13 HRESULT DeleteSavedCredentials(LPWSTR serverName)

指定したリモートコンピューターの保存された資格情報を削除します。

serverName

LPWSTR

リモートコンピューターの名前。DNS 名または IP アドレスを指定できます。

戻り値

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

vtbl 14 HRESULT UpdateSessionDisplaySettings(DWORD width, DWORD height)

リモートデスクトッププロトコル (RDP) アプリコンテナークライアントコントロールの幅と高さの設定を更新します。

width	DWORD	in	更新後のセッション表示領域の幅をピクセル単位で指定する。
height	DWORD	in	更新後のセッション表示領域の高さをピクセル単位で指定する。

戻り値

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

vtbl 15 HRESULT attachEvent(LPWSTR eventName, IDispatch* callback)

イベントハンドラーをイベントにアタッチします。

eventName	LPWSTR	in	登録するイベントの名前を表すワイド文字列を指定する。
callback	IDispatch*	inoptional	イベント発生時に呼び出されるコールバックを実装した IDispatch インターフェイスへのポインタである。

戻り値

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

vtbl 16 HRESULT detachEvent(LPWSTR eventName, IDispatch* callback)

イベントハンドラーをイベントからデタッチします。

eventName	LPWSTR	in	登録を解除するイベントの名前を表すワイド文字列を指定する。
callback	IDispatch*	inoptional	登録解除する対象のコールバックを実装した IDispatch インターフェイスへのポインタである。

戻り値

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IRemoteDesktopClient "{57D25668-625A-4905-BE4E-304CAA13F89C}"
#usecom global IRemoteDesktopClient IID_IRemoteDesktopClient "{}"
#comfunc global IRemoteDesktopClient_Connect                       7
#comfunc global IRemoteDesktopClient_Disconnect                    8
#comfunc global IRemoteDesktopClient_Reconnect                     9 int,int
#comfunc global IRemoteDesktopClient_get_Settings                  10 sptr
#comfunc global IRemoteDesktopClient_get_Actions                   11 sptr
#comfunc global IRemoteDesktopClient_get_TouchPointer              12 sptr
#comfunc global IRemoteDesktopClient_DeleteSavedCredentials        13 wstr
#comfunc global IRemoteDesktopClient_UpdateSessionDisplaySettings  14 int,int
#comfunc global IRemoteDesktopClient_attachEvent                   15 wstr,sptr
#comfunc global IRemoteDesktopClient_detachEvent                   16 wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。