IWMRegisterCallback
COM公式ドキュメント
IWMRegisterCallback インターフェイスを使用すると、アプリケーションはシンクオブジェクトからステータスメッセージを取得できます。既定では、ライターオブジェクトはシンクオブジェクトからのステータスメッセージをアプリケーションに送信しません。
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
Advise メソッドは、シンクオブジェクトからステータスメッセージを受け取るためにアプリケーションを登録します。
| pCallback | IWMStatusCallback* | in | アプリケーションの IWMStatusCallback インターフェイスへのポインター。アプリケーションはこのインターフェイスを実装する必要があります。 |
| pvContext | void* | in | アプリケーションが使用する汎用ポインター。これは OnStatus の呼び出し時にアプリケーションに渡されます。 |
戻り値
メソッドが成功すると、S_OK を返します。失敗すると、HRESULT エラーコードを返します。
解説(Remarks)
シンクオブジェクトは、アプリケーションの IWMStatusCallback::OnStatus メソッドを呼び出すことで、アプリケーションにステータスメッセージを送信します。
アプリケーションがシンクオブジェクトの使用を終えたら、Unadvise メソッドを使用してシンクオブジェクトとの接続を切断します。
Unadvise メソッドは、アプリケーションの IWMStatusCallback コールバックインターフェイスの登録を解除します。アプリケーションがシンクオブジェクトの使用を終えたときにこのメソッドを呼び出します。これにより、オブジェクトに対してアプリケーションへのステータスイベントの送信を停止するよう通知します。
| pCallback | IWMStatusCallback* | in | オブジェクトの IWMStatusCallback インターフェイスへのポインター。 |
| pvContext | void* | in | アプリケーションが使用する汎用ポインター。 |
戻り値
メソッドが成功すると、S_OK を返します。失敗すると、HRESULT エラーコードを返します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IWMRegisterCallback "{CF4B1F99-4DE2-4E49-A363-252740D99BC1}"
#usecom global IWMRegisterCallback IID_IWMRegisterCallback "{}"
#comfunc global IWMRegisterCallback_Advise 3 sptr,sptr
#comfunc global IWMRegisterCallback_Unadvise 4 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。