IWiaItem::EnumChildItems method (wia_xp.h)

Article
02/22/2024

The IWiaItem::EnumChildItems method creates an enumerator object and passes back a pointer to its IEnumWiaItem interface for non-empty folders in a IWiaItem tree of a Windows Image Acquisition (WIA) device.

Syntax

HRESULT EnumChildItems(
  [out] IEnumWiaItem **ppIEnumWiaItem
);

Parameters

[out] ppIEnumWiaItem

Type: IEnumWiaItem**

Receives the address of a pointer to the IEnumWiaItem interface that IWiaItem::EnumChildItems creates.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The WIA run-time system represents each WIA hardware device as a hierarchical tree of IWiaItem objects. The IWiaItem::EnumChildItems method enables applications to enumerate child items in the current item. However, it can only be applied to items that are folders.

If the folder is not empty, it contains a subtree of IWiaItem objects. The IWiaItem::EnumChildItems method enumerates all of the items contained in the folder. It stores a pointer to an enumerator in the ppIEnumWiaItem parameter. Applications use the enumerator pointer to perform the enumeration of an object's child items.

Applications must call the IUnknown::Release method on the interface pointers they receive through the ppIEnumWiaItem parameter.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	wia_xp.h (include Wia.h)
Library	Wiaguid.lib
DLL	Wiaservc.dll

Share via