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

IEnumWIA_DEV_INFO

COM
IID5e38b83c-8cf1-11d1-bf92-0060081ed811継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IEnumWIA_DEV_INFO インターフェイスは、現在利用可能な Windows Image Acquisition (WIA) ハードウェアデバイスとそのプロパティを列挙します。デバイス情報プロパティは、WIA ハードウェアデバイスのインストール状況と構成を表します。

解説(Remarks)

IEnumWIA_DEV_INFO インターフェイスは、標準の OLE 列挙インターフェイスを WIA 向けに実装したものです。詳細については、IEnumXXXX を参照してください。

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

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

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

メソッド 5

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

vtbl 3 HRESULT Next(DWORD celt, IWiaPropertyStorage** rgelt, DWORD* pceltFetched)

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

celtDWORDinrgelt パラメーターで示される配列の要素数を指定します。
rgeltIWiaPropertyStorage**outIWiaPropertyStorage インターフェイスポインターの配列のアドレスを受け取ります。IEnumWIA_DEV_INFO::Next は、この配列にインターフェイスポインターを格納します。
pceltFetchedDWORD*inout出力時、このパラメーターには rgelt パラメーターで示される配列に実際に格納されたインターフェイスポインターの数が入ります。

戻り値

型: HRESULT

列挙するデバイスが残っている間、このメソッドは S_OK を返します。列挙が完了すると S_FALSE を返します。メソッドが失敗した場合は、標準の COM エラーコードを返します。

解説(Remarks)

アプリケーションは、利用可能な各 Windows Image Acquisition (WIA) ハードウェアデバイスのプロパティを照会するためにこのメソッドを使用します。そのために、アプリケーションは自身が確保した IWiaPropertyStorage インターフェイスポインターの配列を渡します。また、celt パラメーターで配列の要素数を渡します。IEnumWIA_DEV_INFO::Next メソッドは、この配列を IWiaPropertyStorage インターフェイスへのポインターで埋めます。アプリケーションは、これらのインターフェイスに対してデバイスがサポートするプロパティを照会できます。

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

vtbl 4 HRESULT Skip(DWORD celt)

IEnumWIA_DEV_INFO::Skip メソッドは、利用可能なデバイスの列挙中に、指定した数のハードウェアデバイスをスキップします。

celtDWORDinスキップするデバイスの数を指定します。

戻り値

型: HRESULT

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

vtbl 5 HRESULT Reset()

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

戻り値

型: HRESULT

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

vtbl 6 HRESULT Clone(IEnumWIA_DEV_INFO** ppIEnum)

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

ppIEnumIEnumWIA_DEV_INFO**outIEnumWIA_DEV_INFO インターフェイスへのポインターです。このパラメーターには、IEnumWIA_DEV_INFO::Clone が作成した IEnumWIA_DEV_INFO インターフェイスインスタンスへのポインターが格納されます。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 7 HRESULT GetCount(DWORD* celt)

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

celtDWORD*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_IEnumWIA_DEV_INFO "{5E38B83C-8CF1-11D1-BF92-0060081ED811}"
#usecom global IEnumWIA_DEV_INFO IID_IEnumWIA_DEV_INFO "{}"
#comfunc global IEnumWIA_DEV_INFO_Next      3 int,sptr,var
#comfunc global IEnumWIA_DEV_INFO_Skip      4 int
#comfunc global IEnumWIA_DEV_INFO_Reset     5
#comfunc global IEnumWIA_DEV_INFO_Clone     6 sptr
#comfunc global IEnumWIA_DEV_INFO_GetCount  7 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。