ホーム › Devices.Tapi › ITCollection

ITCollection

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

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

IID5ec5acf2-9c02-11d0-8362-00aa003ccabd継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITCollection インターフェイスは、Visual Basic で記述されたものなどの Automation クライアントアプリケーションが、コレクション情報を取得できるようにします。

メソッド 3

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

vtbl 7 HRESULT get_Count(INT* lCount)

get_Count メソッドは、コレクション内の項目数を取得します。

lCount

INT*

out

項目数。

戻り値

このメソッドは、次のいずれかの値を返します。

リターンコード	説明
S_OK	メソッドは成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

vtbl 8 HRESULT get_Item(INT Index, VARIANT* pVariant)

get_Item メソッドは、インデックスを指定すると、コレクション内の項目を返します。

Index	INT	in	取得する項目のインデックス。
pVariant	VARIANT*	out	返される項目へのポインター。

戻り値

このメソッドは、次のいずれかの値を返します。

リターンコード	説明
S_OK	メソッドは成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

vtbl 9 HRESULT get__NewEnum(IUnknown** ppNewEnum)

get__NewEnum メソッドは、コレクションの列挙子を取得します。

ppNewEnum

IUnknown**

out

コレクションの列挙子オブジェクト上の IUnknown インターフェイスへのポインター。

返された IUnknown インターフェイスで QueryInterface メソッドを呼び出して、コレクション上の IEnumVARIANT 列挙インターフェイスへのポインターを取得します。IEnumVARIANT は、コレクションを反復処理するために使用できる複数のメソッドを提供します。

詳細については、次の「解説」セクションを参照してください。

戻り値

このメソッドは、次のいずれかの値を返します。

リターンコード	説明
S_OK	メソッドは成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。

解説(Remarks)

コレクションを返すメソッドを含む各 TAPI 3 インターフェイスには、TAPI 3 列挙子インターフェイスへのポインターを返すメソッドも含まれています。C/C++ でプログラミングしている場合は、ITCollection::get__NewEnum メソッドを呼び出す代わりに、コレクションの列挙子メソッドを直接呼び出して列挙子オブジェクトを取得する方が簡単な場合があります。たとえば、 ITTAPI::EnumerateAddresses メソッドは、 IEnumAddress インターフェイスへのポインターを返します。 IEnumAddress は、 Address オブジェクトの列挙メソッドを提供します。

Visual Basic でプログラミングしている場合は、コレクションを列挙するためにこのメソッドを呼び出す必要はありません。これは、For...Each...in...Next... 構文を使用して、メソッドの機能を暗黙的に呼び出すことができるためです。

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