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

IRDPSRAPISharingSession

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDeeb20886-e470-4cf6-842b-2739c0ec5cfb継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

コラボレーションセッションを開始するためにアプリケーションが作成しなければならないメインのオブジェクトです。(IRDPSRAPISharingSession)

メソッド 14

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

vtbl 7 HRESULT Open()

セッションをアクティブな状態にします。

戻り値

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、戻り値はエラーコードです。以下は取り得る値です。

vtbl 8 HRESULT Close()

すべての参加者をセッションから切断し、着信接続の待ち受けを停止します。

戻り値

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、戻り値はエラーコードです。

vtbl 9 HRESULT put_ColorDepth(INT colorDepth)

共有セッションの色深度を取得または設定します。(Put)

colorDepthINTinセッションで使用する色深度 (ピクセルあたりのビット数) を指定する整数である。
vtbl 10 HRESULT get_ColorDepth(INT* pColorDepth)

共有セッションの色深度を取得または設定します。(Get)

pColorDepthINT*outセッションで使用されている色深度 (ピクセルあたりのビット数) を受け取る整数へのポインタである。
vtbl 11 HRESULT get_Properties(IRDPSRAPISessionProperties** ppVal)

IRDPSRAPISessionProperties インターフェイスを実装するオブジェクトを取得します。

ppValIRDPSRAPISessionProperties**outセッションのプロパティを管理する IRDPSRAPISessionProperties インターフェイスを受け取るポインタである。
vtbl 12 HRESULT get_Attendees(IRDPSRAPIAttendeeManager** ppVal)

IRDPSRAPIAttendeeManager インターフェイスを実装するオブジェクトを返します。(IRDPSRAPISharingSession.get_Attendees)

ppValIRDPSRAPIAttendeeManager**outセッションの参加者を管理する IRDPSRAPIAttendeeManager インターフェイスを受け取るポインタである。
vtbl 13 HRESULT get_Invitations(IRDPSRAPIInvitationManager** ppVal)

IRDPSRAPIInvitationManager インターフェイスを実装するオブジェクトを返します。(IRDPSRAPISharingSession.get_Invitations)

ppValIRDPSRAPIInvitationManager**outセッションの招待を管理する IRDPSRAPIInvitationManager インターフェイスを受け取るポインタである。
vtbl 14 HRESULT get_ApplicationFilter(IRDPSRAPIApplicationFilter** ppVal)

IRDPSRAPIApplicationFilter インターフェイスを実装するオブジェクトを返します。(IRDPSRAPISharingSession.get_ApplicationFilter)

ppValIRDPSRAPIApplicationFilter**out共有対象を制御するアプリケーションフィルタ IRDPSRAPIApplicationFilter インターフェイスを受け取るポインタである。
vtbl 15 HRESULT get_VirtualChannelManager(IRDPSRAPIVirtualChannelManager** ppVal)

IRDPSRAPIVirtualChannelManager インターフェイスを実装するオブジェクトを取得します。

ppValIRDPSRAPIVirtualChannelManager**out仮想チャネルを管理する IRDPSRAPIVirtualChannelManager インターフェイスを受け取るポインタである。
vtbl 16 HRESULT Pause()

IRDPSRAPISharingSession::Resume が呼び出されるまで、共有元からすべてのビューアーへ送信されるグラフィックスストリームを一時停止します。

戻り値

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、戻り値はエラーコードです。

vtbl 17 HRESULT Resume()

共有元からすべてのビューアーへ送信されるグラフィックスストリームを再開させます。ストリームは IRDPSRAPISharingSession::Pause または IRDPSRAPISharingSession::Close が呼び出されるまで継続します。

戻り値

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、戻り値はエラーコードです。

vtbl 18 HRESULT ConnectToClient(LPWSTR bstrConnectionString)

共有元がビューアーに接続するリバース接続モードで使用します。

bstrConnectionStringLPWSTRinビューアーが IM や電子メールを通じて帯域外で共有元に送信する接続文字列です。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、戻り値はエラーコードです。

vtbl 19 HRESULT SetDesktopSharedRect(INT left, INT top, INT right, INT bottom)

共有するデスクトップ領域を設定します。

leftINTin共有する矩形の左上隅の X 座標です。
topINTin共有する矩形の左上隅の Y 座標です。
rightINTin共有する矩形の右下隅の X 座標です。
bottomINTin共有する矩形の右下隅の Y 座標です。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、戻り値はエラーコードです。

vtbl 20 HRESULT GetDesktopSharedRect(INT* pleft, INT* ptop, INT* pright, INT* pbottom)

現在共有されているデスクトップ領域を取得します。

pleftINT*out共有する矩形の左上隅の X 座標です。
ptopINT*out共有する矩形の左上隅の Y 座標です。
prightINT*out共有する矩形の右下隅の X 座標です。
pbottomINT*out共有する矩形の右下隅の Y 座標です。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、戻り値はエラーコードです。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IRDPSRAPISharingSession "{EEB20886-E470-4CF6-842B-2739C0EC5CFB}"
#usecom global IRDPSRAPISharingSession IID_IRDPSRAPISharingSession "{}"
#comfunc global IRDPSRAPISharingSession_Open                       7
#comfunc global IRDPSRAPISharingSession_Close                      8
#comfunc global IRDPSRAPISharingSession_put_ColorDepth             9 int
#comfunc global IRDPSRAPISharingSession_get_ColorDepth             10 var
#comfunc global IRDPSRAPISharingSession_get_Properties             11 sptr
#comfunc global IRDPSRAPISharingSession_get_Attendees              12 sptr
#comfunc global IRDPSRAPISharingSession_get_Invitations            13 sptr
#comfunc global IRDPSRAPISharingSession_get_ApplicationFilter      14 sptr
#comfunc global IRDPSRAPISharingSession_get_VirtualChannelManager  15 sptr
#comfunc global IRDPSRAPISharingSession_Pause                      16
#comfunc global IRDPSRAPISharingSession_Resume                     17
#comfunc global IRDPSRAPISharingSession_ConnectToClient            18 wstr
#comfunc global IRDPSRAPISharingSession_SetDesktopSharedRect       19 int,int,int,int
#comfunc global IRDPSRAPISharingSession_GetDesktopSharedRect       20 var,var,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。