EnumChildItems Method

public void EnumChildItems( 
   object parentItem
)

'Declaration
 
Public Sub EnumChildItems( _
   ByVal parentItem As Object _
) 

'Usage
 
Dim instance As WiaSession
Dim parentItem As Object
 
instance.EnumChildItems(parentItem)

public:
void EnumChildItems( 
   Object^ parentItem
) 

Parameters

parentItem

Handle to the item which represents the root item having its child items enumerated.

The WIA run-time system represents each WIA hardware device in a hierarchical tree of items. This function enables applications to enumerate the child items for the specified root item.

Pass a valid parentItem parameter. To do so, retrieve a pointer to the device's root Item itself by calling the GetRootItem method and then pass the retrieved item to the EnumChildItems method as the parent item for the child items.

Each enumerated item will be sent to the user through the EnumItemsEvent event. Add this event when enumerating the device's child items. To cancel the enumeration proces, add the EnumItemsEvent event and then set the Cancel member of the WiaEnumItemsEventArgs to true.

For each received item through the EnumItemsEvent event call FreeItem method. Save the received items in a list or array and when the list is not needed anymore, loop through the list items and call the FreeItem method for each of them.

For more information, refer to Managing WIA Sources.

Target Platforms

Reference

WiaSession Class
WiaSession Members
Startup Method
Shutdown Method
FreeItem Method
GetRootItem Method
GetProperties Method
SetProperties Method