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

IRDPSRAPIInvitation

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

公式ドキュメント

招待により、個人または複数の人々がセッションに接続できるようになります。参加者がセッションに接続すると、クライアントはチケットとパスワードを送信します。これら 2 つの情報は、参加者を認証するために使用されます。

メソッド 7

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

vtbl 7 HRESULT get_ConnectionString(LPWSTR* pbstrVal)

チケット文字列です。

pbstrValLPWSTR*out接続に使用する接続文字列を受け取る文字列バッファへのポインタである。呼び出し側が解放する。

解説(Remarks)

チケット文字列は、IRDPSRAPIInvitationManager::CreateInvitation メソッドを呼び出したときに設定されます。

vtbl 8 HRESULT get_GroupName(LPWSTR* pbstrVal)

グループ名です。

pbstrValLPWSTR*out招待が属するグループ名を受け取る文字列バッファへのポインタである。呼び出し側が解放する。

解説(Remarks)

グループ名は、IRDPSRAPIInvitationManager::CreateInvitation メソッドを呼び出したときに設定されます。アプリケーションは通常、このプロパティを使用して参加者を複数のグループに分け、それぞれに異なる認可レベルを付与します。

vtbl 9 HRESULT get_Password(LPWSTR* pbstrVal)

パスワード文字列です。

pbstrValLPWSTR*out招待に設定されたパスワードを受け取る文字列バッファへのポインタである。呼び出し側が解放する。

解説(Remarks)

パスワードは、IRDPSRAPIInvitationManager::CreateInvitation メソッドを呼び出したときに設定されます。

vtbl 10 HRESULT get_AttendeeLimit(INT* pRetVal)

セッションに接続できる参加者の最大数です。(Get)

pRetValINT*outこの招待で許可される参加者の上限数を受け取る整数へのポインタである。

解説(Remarks)

パスワードは招待の作成時に設定され、put_AttendeeLimit を使用して変更できます。

vtbl 11 HRESULT put_AttendeeLimit(INT NewVal)

セッションに接続できる参加者の最大数です。(Put)

NewValINTinこの招待で許可する参加者の上限数を指定する整数である。

解説(Remarks)

パスワードは招待の作成時に設定され、put_AttendeeLimit を使用して変更できます。

vtbl 12 HRESULT get_Revoked(VARIANT_BOOL* pRetVal)

招待の失効状態です。(Get)

pRetValVARIANT_BOOL*out招待が無効化されているかどうかを示す VARIANT_BOOL を受け取るポインタである。

解説(Remarks)

招待を削除する方法はなく、失効させることのみが可能です。これにより、アプリケーションはチケットが以前に発行されたかどうかを確認でき、各招待が一意のチケットを持つことを保証できます。招待の状態が失効になっている場合、その招待を使用して新たに参加者が接続することはできません。

vtbl 13 HRESULT put_Revoked(VARIANT_BOOL NewVal)

招待の失効状態です。(Put)

NewValVARIANT_BOOLin招待を無効化するかどうかを指定する VARIANT_BOOL である。VARIANT_TRUE で無効化する。

解説(Remarks)

招待を削除する方法はなく、失効させることのみが可能です。これにより、アプリケーションはチケットが以前に発行されたかどうかを確認でき、各招待が一意のチケットを持つことを保証できます。招待の状態が失効になっている場合、その招待を使用して新たに参加者が接続することはできません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IRDPSRAPIInvitation "{4FAC1D43-FC51-45BB-B1B4-2B53AA562FA3}"
#usecom global IRDPSRAPIInvitation IID_IRDPSRAPIInvitation "{49174DC6-0731-4B5E-8EE1-83A63D3868FA}"
#comfunc global IRDPSRAPIInvitation_get_ConnectionString  7 var
#comfunc global IRDPSRAPIInvitation_get_GroupName         8 var
#comfunc global IRDPSRAPIInvitation_get_Password          9 var
#comfunc global IRDPSRAPIInvitation_get_AttendeeLimit     10 var
#comfunc global IRDPSRAPIInvitation_put_AttendeeLimit     11 int
#comfunc global IRDPSRAPIInvitation_get_Revoked           12 var
#comfunc global IRDPSRAPIInvitation_put_Revoked           13 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。