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

ITFileTerminalEvent

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDe4a7fbac-8c17-4427-9f55-9f589ac8af00継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITFileTerminalEvent インターフェースは、発生したファイルターミナルイベントの説明を取得するメソッドを含みます。

メソッド 6

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

vtbl 7 HRESULT get_Terminal(ITTerminal** ppTerminal)

get_Terminal メソッドは、このイベントを生成したファイルターミナルを返します。

ppTerminalITTerminal**outITTerminal インターフェースへのポインター。

戻り値

このメソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

vtbl 8 HRESULT get_Track(ITFileTrack** ppTrackTerminal)

get_Track メソッドは、このイベントを生成したトラックターミナルを返します。

ppTrackTerminalITFileTrack**outITFileTrack インターフェースへのポインター。

戻り値

このメソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

vtbl 9 HRESULT get_Call(ITCallInfo** ppCall)

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

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

戻り値

このメソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

解説(Remarks)

ターミナルがイベントを生成する必要がある場合、そのイベントを MSP に渡すために選択されたトラックが必要となり、MSP は次にそれを TAPI を通じてアプリケーションへ渡します。イベントの送信タスクを最初に受け入れたトラックが使用されます。ターミナルが複数のトラックを持ち、それらのトラックが異なる通話に属するストリームに選択されている場合、最終的に返される通話オブジェクトのポインターは、それらの通話のいずれかを指す可能性があります。

vtbl 10 HRESULT get_State(TERMINAL_MEDIA_STATE* pState)

get_State メソッドは、新しいファイルターミナルの状態に関する情報を取得します。

pStateTERMINAL_MEDIA_STATE*out新しいターミナルの状態を表す TERMINAL_MEDIA_STATE 記述子。

戻り値

このメソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

vtbl 11 HRESULT get_Cause(FT_STATE_EVENT_CAUSE* pCause)

get_Cause メソッドは、このイベントに関連付けられた原因を取得します。(ITFileTerminalEvent.get_Cause)

pCauseFT_STATE_EVENT_CAUSE*outこのイベントの原因を表す FT_STATE_EVENT_CAUSE 記述子。

戻り値

このメソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

vtbl 12 HRESULT get_Error(HRESULT* phrErrorCode)

get_Error メソッドは、イベントのエラーコードを取得します。

phrErrorCodeHRESULT*outこのイベントに関連付けられたエラーコードの HRESULT キャスト。

戻り値

このメソッドが成功した場合は 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_ITFileTerminalEvent "{E4A7FBAC-8C17-4427-9F55-9F589AC8AF00}"
#usecom global ITFileTerminalEvent IID_ITFileTerminalEvent "{}"
#comfunc global ITFileTerminalEvent_get_Terminal  7 sptr
#comfunc global ITFileTerminalEvent_get_Track     8 sptr
#comfunc global ITFileTerminalEvent_get_Call      9 sptr
#comfunc global ITFileTerminalEvent_get_State     10 var
#comfunc global ITFileTerminalEvent_get_Cause     11 var
#comfunc global ITFileTerminalEvent_get_Error     12 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。