ホーム › Devices.ImageAcquisition › IEnumWiaItem

IEnumWiaItem

COM

📘 Microsoft Learn (日本語) · English

IID5e8383fc-3391-11d2-9a33-00c04fa36145継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumWiaItem インターフェイスは、ツリーの現在のフォルダー内にある IWiaItem オブジェクトをアプリケーションが列挙するために使用します。

解説(Remarks)

IEnumWiaItem インターフェイスは、標準的な Component Object Model (COM) 列挙インターフェイスを WIA 向けに実装したものです。詳細については、IEnumXXXX を参照してください。

アプリケーションは、IWiaItem::EnumChildItems メソッドを呼び出すことで IEnumWiaItem インターフェイスへのポインターを取得します。

IEnumWiaItem インターフェイスは、すべての COM インターフェイスと同様に、IUnknown インターフェイスのメソッドを継承します。

IUnknown のメソッド	説明
IUnknown::QueryInterface	サポートされているインターフェイスへのポインターを返します。
IUnknown::AddRef	参照カウントをインクリメントします。
IUnknown::Release	参照カウントをデクリメントします。

メソッド 5

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

vtbl 3 HRESULT Next(DWORD celt, IWiaItem** ppIWiaItem, DWORD* pceltFetched)

IEnumWiaItem::Next メソッドは、IWiaItem インターフェイスへのポインターの配列を埋めます。

celt	DWORD	in	ppIWiaItem パラメーターで示される配列の要素数を指定します。
ppIWiaItem	IWiaItem**	out	IWiaItem インターフェイスポインターの配列のアドレスを受け取ります。IEnumWiaItem::Next はこの配列にインターフェイスポインターを格納します。
pceltFetched	DWORD*	inout	出力時、このパラメーターは ppIWiaItem パラメーターで示される配列に実際に格納されたインターフェイスポインターの数を受け取ります。列挙が完了すると、このパラメーターには 0 が格納されます。

戻り値

型: HRESULT

メソッドが成功した場合は S_OK を返します。列挙が完了した場合は S_FALSE を返します。メソッドが失敗した場合は、標準の COM エラーコードを返します。

解説(Remarks)

Windows Image Acquisition (WIA) ランタイムシステムは、WIA ハードウェアデバイスを IWiaItem オブジェクトの階層ツリーとして表現します。アプリケーションは IEnumWiaItem::Next メソッドを使用して、ハードウェアデバイスの IWiaItem オブジェクトツリーの現在のフォルダー内にある各アイテムの IWiaItem インターフェイスポインターを取得します。

ポインターの一覧を取得するには、アプリケーションは自身が割り当てた IWiaItem インターフェイスポインターの配列を渡します。また、celt パラメーターに配列の要素数を渡します。IEnumWiaItem::Next メソッドは、その配列を IWiaItem インターフェイスへのポインターで埋めます。

列挙処理が完了するまで、IEnumWiaItem::Next メソッドは S_OK を返します。その際、pceltFetched が指す値に、配列へ挿入したアイテムの数を設定します。IEnumWiaItem::Next が IWiaItem オブジェクトの列挙処理を終えると、S_FALSE を返し、pceltFetched が指すメモリ位置に 0 を設定します。

アプリケーションは、ppIWiaItem パラメーターを通じて受け取ったインターフェイスポインターに対して IUnknown::Release メソッドを呼び出す必要があります。

vtbl 4 HRESULT Skip(DWORD celt)

IEnumWiaItem::Skip メソッドは、利用可能な IWiaItem オブジェクトの列挙中に、指定した数のアイテムをスキップします。

celt

DWORD

スキップするアイテムの数を指定します。

戻り値

型: HRESULT

メソッドが成功した場合は S_OK を返します。指定した数のアイテムをスキップできなかった場合は S_FALSE を返します。メソッドが失敗した場合は、標準の COM エラーコードを返します。

vtbl 5 HRESULT Reset()

IEnumWiaItem::Reset メソッドは、アイテム情報の列挙を最初からやり直すためにアプリケーションが使用します。

戻り値

型: HRESULT

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

vtbl 6 HRESULT Clone(IEnumWiaItem** ppIEnum)

IEnumWiaItem::Clone メソッドは、IEnumWiaItem インターフェイスのインスタンスをもう 1 つ作成し、そのポインターを返します。

ppIEnum

IEnumWiaItem**

out

IEnumWiaItem インターフェイスへのポインターです。IEnumWiaItem::Clone が作成した IEnumWiaItem インターフェイスインスタンスのアドレスを受け取ります。

戻り値

型: HRESULT

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

解説(Remarks)

アプリケーションは、ppIEnum パラメーターを通じて受け取ったインターフェイスポインターに対して IUnknown::Release メソッドを呼び出す必要があります。

vtbl 7 HRESULT GetCount(DWORD* celt)

IEnumWiaItem::GetCount メソッドは、この列挙子が保持している要素の数を返します。

celt

DWORD*

out

列挙内の要素数を受け取る ULONG へのポインターです。

戻り値

型: 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_IEnumWiaItem "{5E8383FC-3391-11D2-9A33-00C04FA36145}"
#usecom global IEnumWiaItem IID_IEnumWiaItem "{}"
#comfunc global IEnumWiaItem_Next      3 int,sptr,var
#comfunc global IEnumWiaItem_Skip      4 int
#comfunc global IEnumWiaItem_Reset     5
#comfunc global IEnumWiaItem_Clone     6 sptr
#comfunc global IEnumWiaItem_GetCount  7 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IEnumWiaItem "{5E8383FC-3391-11D2-9A33-00C04FA36145}"
#usecom global IEnumWiaItem IID_IEnumWiaItem "{}"
#comfunc global IEnumWiaItem_Next      3 int,sptr,sptr
#comfunc global IEnumWiaItem_Skip      4 int
#comfunc global IEnumWiaItem_Reset     5
#comfunc global IEnumWiaItem_Clone     6 sptr
#comfunc global IEnumWiaItem_GetCount  7 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。