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

IRendezvousSession

COM
IID9ba4b1dd-8b0c-48b7-9e7c-2f25857c8df5継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

セッションに関するデータを送信し、セッションを終了できるメソッドを公開します。

解説(Remarks)

インスタント メッセージング (IM) アプリケーションはこのインターフェイスを実装し、IRendezvousSession を実装して DRendezvousSessionEvents 接続ポイントをサポートするオブジェクトを渡します。

Windows リモート アシスタンス アプリケーションは、SetRendezvousSession の呼び出しが完了した後にセッションを保持するため、IRendezvousSession->AddRef を呼び出します。

Windows リモート アシスタンス アプリケーションは、セッションが完了すると IRendezvousSession->Release を呼び出します。

メソッド 5

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

vtbl 3 HRESULT get_State(RENDEZVOUS_SESSION_STATE* pSessionState)

セッションの状態を示す値を取得します。

pSessionStateRENDEZVOUS_SESSION_STATE*outランデブーセッションの現在の状態 (RENDEZVOUS_SESSION_STATE) を受け取る。
vtbl 4 HRESULT get_RemoteUser(LPWSTR* bstrUserName)

Windows Messenger の連絡先名を格納する BSTR へのポインターを取得します。

bstrUserNameLPWSTR*out接続先リモートユーザーの名前を表す文字列を受け取る。呼び出し側が解放する。
vtbl 5 HRESULT get_Flags(INT* pFlags)

セッション情報を示す値を取得します。たとえば、セッション フラグはユーザーが招待者と被招待者のいずれであるかを示すことができます。

pFlagsINT*outセッションに関するフラグを受け取る。
vtbl 6 HRESULT SendContextData(LPWSTR bstrData)

コンテキスト データをリモートの RendezvousApplication に送信します。

bstrDataLPWSTRinアプリケーションのコンテキスト データを指定する BSTR です。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

戻り値 説明
S_OK
コンテキスト データが正常に送信されました。
E_INVALIDARG
メソッドに渡されたコンテキスト データが無効です。
E_OUTOFMEMORY
コンテキスト データを送信するのに十分なメモリがありません。
vtbl 7 HRESULT Terminate(HRESULT hr, LPWSTR bstrAppData)

リモートの RendezvousApplication を終了します。

hrHRESULTinアプリケーション終了時の HRESULT です。
bstrAppDataLPWSTRinアプリケーション データです。

戻り値

このメソッドが成功した場合は 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_IRendezvousSession "{9BA4B1DD-8B0C-48B7-9E7C-2F25857C8DF5}"
#usecom global IRendezvousSession IID_IRendezvousSession "{}"
#comfunc global IRendezvousSession_get_State        3 var
#comfunc global IRendezvousSession_get_RemoteUser   4 var
#comfunc global IRendezvousSession_get_Flags        5 var
#comfunc global IRendezvousSession_SendContextData  6 wstr
#comfunc global IRendezvousSession_Terminate        7 int,wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。