Win32 API 日本語リファレンス
ホームDevices.Tapi › ITPrivateEvent

ITPrivateEvent

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID0e269cd0-10d4-4121-9c22-9c85d625650d継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITPrivateEvent インターフェイスは、プライベートオブジェクトによって生成されたイベントをアプリケーションが処理できるようにするメソッドを公開します。

メソッド 5

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

vtbl 7 HRESULT get_Address(ITAddress** ppAddress)

get_Address メソッドは、イベントに関与するプライベートオブジェクトへの ITAddress インターフェイスポインターを取得します。

ppAddressITAddress**outITAddress インターフェイスへのポインター。

戻り値

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

意味
S_OK
メソッドは成功しました。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_POINTER
ppAddress パラメーターが有効なポインターではありません。
vtbl 8 HRESULT get_Call(ITCallInfo** ppCallInfo)

get_Call メソッドは、イベントが発生した通話(コール)の ITCallInfo インターフェイスへのポインターを返します。(ITPrivateEvent.get_Call)

ppCallInfoITCallInfo**outITCallInfo インターフェイスへのポインター。

戻り値

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

意味
S_OK
メソッドは成功しました。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_POINTER
ppCallInfo パラメーターが有効なポインターではありません。
vtbl 9 HRESULT get_CallHub(ITCallHub** ppCallHub)

get_CallHub メソッドは、イベントが発生した ITCallHub インターフェイスへのポインターを返します。(ITPrivateEvent.get_CallHub)

ppCallHubITCallHub**outITCallHub インターフェイスへのポインター。

戻り値

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

意味
S_OK
メソッドは成功しました。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_POINTER
ppCallHub パラメーターが有効なポインターではありません。
vtbl 10 HRESULT get_EventCode(INT* plEventCode)

get_EventCode メソッドは、プロバイダー固有のイベント記述子へのポインターを返します。

plEventCodeINT*outプロバイダー固有のイベント記述子へのポインター。

戻り値

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

意味
S_OK
メソッドは成功しました。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_POINTER
plEventCode パラメーターが有効なポインターではありません。
vtbl 11 HRESULT get_EventInterface(IDispatch** pEventInterface)

get_EventInterface メソッドは、プライベートオブジェクトのイベントハンドラーの IDispatch インターフェイスへのポインターを返します。

pEventInterfaceIDispatch**outプライベートオブジェクトのイベントハンドラーの IDispatch インターフェイスへのポインター。

戻り値

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

意味
S_OK
メソッドは成功しました。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。
E_POINTER
pEventInterface パラメーターが有効なポインターではありません。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITPrivateEvent "{0E269CD0-10D4-4121-9C22-9C85D625650D}"
#usecom global ITPrivateEvent IID_ITPrivateEvent "{}"
#comfunc global ITPrivateEvent_get_Address         7 sptr
#comfunc global ITPrivateEvent_get_Call            8 sptr
#comfunc global ITPrivateEvent_get_CallHub         9 sptr
#comfunc global ITPrivateEvent_get_EventCode       10 var
#comfunc global ITPrivateEvent_get_EventInterface  11 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。