ITAddressEvent

COMIDispatch (デュアル)

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID831ce2d1-83b5-11d1-bb5c-00c04fb6809f継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITAddressEvent インターフェイスには、アドレスイベントの記述を取得するメソッドが含まれています。

解説(Remarks)

PnP デバイス上の特定のイベントは、 ITTerminalSupport::EnumerateStaticTerminals または ITTerminalSupport::get_StaticTerminals を使用して静的ターミナルを初めて列挙するまでは受信されません。

メソッド 3

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

vtbl 7 HRESULT get_Address(ITAddress** ppAddress)

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

ppAddress

ITAddress**

out

ITAddress インターフェイスへのポインター。

戻り値

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

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

解説(Remarks)

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

vtbl 8 HRESULT get_Event(ADDRESS_EVENT* pEvent)

get_Event メソッドは、イベントの ADDRESS_EVENT 記述子を取得します。

pEvent

ADDRESS_EVENT*

out

イベントの ADDRESS_EVENT 記述子へのポインター。

戻り値

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

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

解説(Remarks)

AE_NEWTERMINAL や AE_REMOVETERMINAL など、PnP デバイス上の特定のイベントは、 ITTerminalSupport::EnumerateStaticTerminals または ITTerminalSupport::get_StaticTerminals を使用して静的ターミナルを初めて列挙するまでは受信されません。

vtbl 9 HRESULT get_Terminal(ITTerminal** ppTerminal)

get_Terminal メソッドは、イベントに関連付けられた ITTerminal インターフェイスへのポインターを取得します。

ppTerminal

ITTerminal**

out

ITTerminal インターフェイスへのポインター。イベントがターミナルを参照しない場合は NULL。

戻り値

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

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

解説(Remarks)

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITAddressEvent "{831CE2D1-83B5-11D1-BB5C-00C04FB6809F}"
#usecom global ITAddressEvent IID_ITAddressEvent "{}"
#comfunc global ITAddressEvent_get_Address   7 sptr
#comfunc global ITAddressEvent_get_Event     8 var
#comfunc global ITAddressEvent_get_Terminal  9 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ITAddressEvent "{831CE2D1-83B5-11D1-BB5C-00C04FB6809F}"
#usecom global ITAddressEvent IID_ITAddressEvent "{}"
#comfunc global ITAddressEvent_get_Address   7 sptr
#comfunc global ITAddressEvent_get_Event     8 sptr
#comfunc global ITAddressEvent_get_Terminal  9 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。