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

IFunctionInstanceCollection

COM
📘 Microsoft Learn (日本語) · English
IIDf0a3d895-855c-42a2-948d-2f97d450ecb1継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

クエリまたはインスタンス取得要求の結果として返される IFunctionInstance オブジェクトのグループを表します。

解説(Remarks)

IFunctionInstanceCollection インターフェイスを使用すると、クライアントプログラムは IFunctionInstance オブジェクトのコレクションを列挙できます。

メソッド 7

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetCount(DWORD* pdwCount)

コレクション内の関数インスタンスの数を取得します。

pdwCountDWORD*out関数インスタンスの数。

戻り値

戻り値には次のものが含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドは正常に完了しました。
E_INVALIDARG
 pdwCount パラメーターが NULL です。

解説(Remarks)

GetCount メソッドと Item メソッドを使用すると、単純な for ループまたは while ループで、コレクションに含まれるすべての関数インスタンスを列挙できます。

vtbl 4 HRESULT Get(LPWSTR pszInstanceIdentity, DWORD* pdwIndex, IFunctionInstance** ppIFunctionInstance)

指定した関数インスタンスとそのインデックスをコレクションから取得します。

pszInstanceIdentityLPWSTRin取得する関数インスタンスの識別子(GetID を参照)。
pdwIndexDWORD*outインデックス番号。
ppIFunctionInstanceIFunctionInstance**out関数インスタンスを受け取る IFunctionInstance インターフェイスポインターへのポインター。

戻り値

戻り値には次のものが含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドは正常に完了しました。
S_FALSE
 pInstanceIdentity で識別される関数インスタンスが、関数インスタンスコレクション内に存在しません。
E_INVALIDARG
 pdwIndex または pInstanceIdentity の値が無効です。
E_OUTOFMEMORY
 この操作の実行に必要なメモリをメソッドが割り当てられません。
vtbl 5 HRESULT Item(DWORD dwIndex, IFunctionInstance** ppIFunctionInstance)

指定した関数インスタンスをインデックスで取得します。

dwIndexDWORDin取得する関数インスタンスの 0 から始まるインデックス。
ppIFunctionInstanceIFunctionInstance**out関数インスタンスを受け取る IFunctionInstance インターフェイスポインターへのポインター。

戻り値

戻り値には次のものが含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドは正常に完了しました。
E_INVALIDARG
 ppFunctionInstance パラメーターが NULL であるか、dwIndex が範囲外です。

解説(Remarks)

GetCount メソッドと Item メソッドを使用すると、単純な for ループまたは while ループで、コレクションに含まれるすべての関数インスタンスを列挙できます。

vtbl 6 HRESULT Add(IFunctionInstance* pIFunctionInstance)

関数インスタンスをコレクションに追加します。

pIFunctionInstanceIFunctionInstance*inコレクションに追加する関数インスタンスの IFunctionInstance インターフェイスへのポインター。

戻り値

戻り値には次のものが含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドは正常に完了しました。
E_INVALIDARG
 pIFunctionInstance の値が無効です。
E_OUTOFMEMORY
 この操作の実行に必要なメモリをメソッドが割り当てられません。
vtbl 7 HRESULT Remove(DWORD dwIndex, IFunctionInstance** ppIFunctionInstance)

指定した関数インスタンスを削除し、削除される関数インスタンスへのポインターを返します。

dwIndexDWORDinコレクション内のインデックス番号。
ppIFunctionInstanceIFunctionInstance**out関数インスタンスを受け取る IFunctionInstance インターフェイスポインターへのポインター。

戻り値

戻り値には次のものが含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドは正常に完了しました。
E_INVALIDARG
 dwIndex の値が無効です。
E_OUTOFMEMORY
 この操作の実行に必要なメモリをメソッドが割り当てられません。
vtbl 8 HRESULT Delete(DWORD dwIndex)

指定した関数インスタンスをコレクションから削除します。

dwIndexDWORDinコレクションから削除する項目のインデックス番号。

戻り値

戻り値には次のものが含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドは正常に完了しました。
E_INVALIDARG
 dwIndex の値が無効です。
E_OUTOFMEMORY
 この操作の実行に必要なメモリをメソッドが割り当てられません。
vtbl 9 HRESULT DeleteAll()

すべての関数インスタンスをコレクションから削除します。

戻り値

このメソッドが成功した場合は 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_IFunctionInstanceCollection "{F0A3D895-855C-42A2-948D-2F97D450ECB1}"
#usecom global IFunctionInstanceCollection IID_IFunctionInstanceCollection "{BA818CE5-B55F-443F-AD39-2FE89BE6191F}"
#comfunc global IFunctionInstanceCollection_GetCount   3 var
#comfunc global IFunctionInstanceCollection_Get        4 wstr,var,sptr
#comfunc global IFunctionInstanceCollection_Item       5 int,sptr
#comfunc global IFunctionInstanceCollection_Add        6 sptr
#comfunc global IFunctionInstanceCollection_Remove     7 int,sptr
#comfunc global IFunctionInstanceCollection_Delete     8 int
#comfunc global IFunctionInstanceCollection_DeleteAll  9
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。