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

ITTAPIObjectEvent

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDf4854d48-937a-11d1-bb58-00c04fb6809f継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITTAPIObjectEvent インターフェイスは、TAPI オブジェクトイベントの説明を取得するメソッドを含みます。

メソッド 4

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

vtbl 7 HRESULT get_TAPIObject(ITTAPI** ppTAPIObject)

get_TAPIObject メソッドは、イベントが発生した TAPI オブジェクトへのポインターを取得します。

ppTAPIObjectITTAPI**outイベントが発生した TAPI オブジェクトの ITTAPI インターフェイスへのポインター。

戻り値

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

Value Meaning
S_OK
メソッドは成功しました。
E_POINTER
ppTAPIObject パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。

解説(Remarks)

TAPI は、ITTAPIObjectEvent::get_TAPIObject が返す ITTAPI インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、 ITTAPI インターフェイスに関連付けられているリソースを解放するために、そのインターフェイスに対して Release を呼び出す必要があります。

vtbl 8 HRESULT get_Event(TAPIOBJECT_EVENT* pEvent)

get_Event メソッドは、非同期イベント通知に関する情報を取得します。アプリケーションは、どの種類のイベントが通知されているかを判断するために TAPIOBJECT_EVENT を使用します。

pEventTAPIOBJECT_EVENT*outイベントを示す TAPIOBJECT_EVENT インジケーター。

戻り値

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

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

get_Address メソッドは、イベントが発生した Address オブジェクトへのポインターを取得します。

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

戻り値

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

Value Meaning
S_OK
メソッドは成功しました。
E_POINTER
ppAddress パラメーターが有効なポインターではありません。
E_OUTOFMEMORY
操作を実行するのに十分なメモリがありません。

解説(Remarks)

TAPI は、ITTAPIObjectEvent::get_Address が返す ITAddress インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、 ITAddress インターフェイスに関連付けられているリソースを解放するために、そのインターフェイスに対して Release を呼び出す必要があります。

vtbl 10 HRESULT get_CallbackInstance(INT* plCallbackInstance)

get_CallbackInstance メソッドは、イベントに関連付けられているコールバックインスタンスへのポインターを取得します。(ITTAPIObjectEvent.get_CallbackInstance)

plCallbackInstanceINT*outITTAPI::RegisterCallNotifications が返すコールバックインスタンスへのポインター。

戻り値

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

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