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

ITAgentHandlerEvent

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

公式ドキュメント

ITAgentHandlerEvent インターフェイス (tapi3cc.h) は、エージェントハンドラーイベントの説明を取得するメソッドを含みます。

メソッド 2

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

vtbl 7 HRESULT get_AgentHandler(ITAgentHandler** ppAgentHandler)

ITAgentHandlerEvent::get_AgentHandler メソッド (tapi3cc.h) は、ITAgentHandler インターフェイスのポインターを取得します。

ppAgentHandlerITAgentHandler**outイベントが発生した ITAgentHandler インターフェイスへのポインター。

戻り値

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

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

解説(Remarks)

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

vtbl 8 HRESULT get_Event(AGENTHANDLER_EVENT* pEvent)

ITAgentHandlerEvent::get_Event メソッド (tapi3cc.h) は、発生したイベントの説明を取得します。(ITAgentHandlerEvent.get_Event)

pEventAGENTHANDLER_EVENT*outAGENTHANDLER_EVENT 記述子へのポインター。

戻り値

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

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