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

IRDPSRAPIAttendee

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

公式ドキュメント

attendee オブジェクトは、クライアントがセッションに接続して認証された結果として作成されます。attendee オブジェクトが作成されると、自動的に参加者リストに追加されます。

解説(Remarks)

アプリケーションは attendee オブジェクトへのポインターを保存しないでください。attendee オブジェクトの有効期間は RDPSession オブジェクトの有効期間に依存します。また、セッションが開いた状態のままであるかどうか、および attendee オブジェクトに対応するクライアントがセッションに接続したままであるかどうかにも依存します。アプリケーションは attendee オブジェクトへの参照を保持できますが、クライアントが切断された後やセッションが破棄された後にその一部のメソッドを呼び出すと、E_UNEXPECTED エラーが返されます。

メソッド 8

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

vtbl 7 HRESULT get_Id(INT* pId)

参加者の一意の識別子です。

pIdINT*out参加者の一意な識別子を受け取る整数へのポインタである。

解説(Remarks)

参加者が切断すると、attendee オブジェクトは破棄されます。参加者が再接続した場合は、新しい識別子を持つ新しいオブジェクトが作成されます。

vtbl 8 HRESULT get_RemoteName(LPWSTR* pVal)

リモートクライアントの名前です。通常は参加者のフレンドリ名です。

pValLPWSTR*out参加者のリモート名を受け取る文字列バッファへのポインタである。呼び出し側が解放する。
vtbl 9 HRESULT get_ControlLevel(CTRL_LEVEL* pVal)

参加者がセッションに対して持つ制御レベルです。(Get)

pValCTRL_LEVEL*out参加者に付与されている制御レベルを受け取る CTRL_LEVEL 列挙値へのポインタである。
vtbl 10 HRESULT put_ControlLevel(CTRL_LEVEL pNewVal)

参加者がセッションに対して持つ制御レベルです。(Put)

pNewValCTRL_LEVELin参加者に設定する制御レベルを指定する CTRL_LEVEL 列挙値である。
vtbl 11 HRESULT get_Invitation(IRDPSRAPIInvitation** ppVal)

参加者に会議へのアクセスを許可するために使用された招待です。

ppValIRDPSRAPIInvitation**outこの参加者が使用した招待を表す IRDPSRAPIInvitation インターフェイスを受け取るポインタである。

解説(Remarks)

アプリケーションは複数の参加者グループを持つことができます。たとえば、アプリケーションは "Moderators" グループと "Spectators" グループを定義できます。"Moderators" グループに属する参加者には対話的な制御が許可され、"Spectators" グループの参加者にはセッションを閲覧するアクセスのみが許可されます。アプリケーションは、グループごとに 1 つずつ、計 2 つの invitation オブジェクトを作成することでこの実装を実現します。参加者が接続すると、アプリケーションは認証に使用された invitation オブジェクトの GroupName プロパティを確認することで、その参加者がどのグループに属するかを判別できます。グループ名が "Spectators" の場合、アプリケーションはその参加者の ControlLevel プロパティを CTRL_LEVEL_VIEW に設定します。グループ名が "Moderators" の場合は、ControlLevel プロパティを CTRL_LEVEL_INTERACTIVE に設定します。

このプロパティをビューアー側でアクセスした場合は、ダミーの招待が返されます。

vtbl 12 HRESULT TerminateConnection()

参加者が表すクライアントを切断します。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は S_OK です。それ以外の場合、戻り値はエラーコードです。次の値が返される可能性があります。

解説(Remarks)

このメソッドはクライアントをセッションから切断します。認証は招待に基づいて行われるため、クライアントは再接続できます。セッションへのアクセス制御をより厳格にするには、アプリケーションは参加者ごとに 1 つの invitation オブジェクトを作成し、このメソッドの呼び出しと同時にその招待を取り消すことができます。

この呼び出しはブロックしません。ただし、切断は即時ではなく、送信操作によって遅延する場合があります。接続を管理しているスレッドがバッファーの送信中である場合、そのバッファーの送信完了を待つ必要があります。呼び出し元は、_IRDPSessionEvents::OnAttendeeDisconnected イベントが発生した後にはじめて、参加者が切断されたと見なすべきです。

vtbl 13 HRESULT get_Flags(INT* plFlags)

RDPENCOMAPI_ATTENDEE_FLAGS 列挙型で定義されている、参加者固有のフラグを取得します。

plFlagsINT*out参加者の状態を示すフラグを受け取る整数へのポインタである。
vtbl 14 HRESULT get_ConnectivityInfo(IUnknown** ppVal)

参加者の接続情報を取得します。

ppValIUnknown**out参加者の接続情報を表すインターフェイス (IRDPSRAPITcpConnectionInfo など) を受け取る IUnknown ポインタである。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IRDPSRAPIAttendee "{EC0671B3-1B78-4B80-A464-9132247543E3}"
#usecom global IRDPSRAPIAttendee IID_IRDPSRAPIAttendee "{}"
#comfunc global IRDPSRAPIAttendee_get_Id                7 var
#comfunc global IRDPSRAPIAttendee_get_RemoteName        8 var
#comfunc global IRDPSRAPIAttendee_get_ControlLevel      9 var
#comfunc global IRDPSRAPIAttendee_put_ControlLevel      10 int
#comfunc global IRDPSRAPIAttendee_get_Invitation        11 sptr
#comfunc global IRDPSRAPIAttendee_TerminateConnection   12
#comfunc global IRDPSRAPIAttendee_get_Flags             13 var
#comfunc global IRDPSRAPIAttendee_get_ConnectivityInfo  14 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。