LWia::EnumCapabilities

Summary

Enumerates all of the available WIA driver capabilities and properties and determines the available values for each one.

Syntax

virtual L_INT LWia::EnumCapabilities(pItem, uFlags)

Parameters

L_VOID* pItem

Valid pointer to a type IWiaItem or IWiaItem2 object (IWiaItem if using WIA Version 1.0; IWiaItem2 if using WIA Version 2.0), which represents the item being enumerated.

Retrieve this parameter by either calling the LWia::GetRootItem function to get a pointer to the device's root item or by enumerating the child items of the device through a call to LWia::EnumChildItems.

L_UINT uFlags

Reserved for future use, pass 0.

Returns

Comments

This feature is available in LEADTOOLS version 16 or higher.

This function enumerates all of the available WIA driver capabilities and properties (and determines the available values for each one) for the specified acquisition source.

Required DLLs and Libraries

• LTWIA
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

LEADTOOLS WIA supports both 32-bit and 64-bit image acquisition for both WIA 1.0 (XP and earlier) and WIA 2.0 (VISTA and later).

See Also

Functions

• LWia::EnumFormats
• LWia::InitSession
• LWia::EndSession
• Class Members

Topics

• Managing WIA Sources
• WIA Functionality: Property Functions

Example

class CMyWIA : public LWia 
{ 
public: 
   L_INT EnumCapabilitiesCallBack(L_INT nCapsCount, pLWIACAPABILITY pCapability); 
}; 
 
L_INT CMyWIA::EnumCapabilitiesCallBack(L_INT nCapsCount, pLWIACAPABILITY pCapability) 
{ 
   UNREFERENCED_PARAMETER(nCapsCount); 
   UNREFERENCED_PARAMETER(pCapability); 
 
   // You can do here any kind of checking or handling to the received capability. 
 
   return WIA_SUCCESS; 
} 
 
L_INT LWIA__EnumCapabilitiesExample() 
{ 
   CMyWIA MyClass; 
   IWiaItem * pRootItem = NULL; 
   L_INT nRet; 
 
   /* Get a pointer to the WIA device's root items */ 
   nRet = MyClass.GetRootItem(NULL, (L_VOID**)&pRootItem); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   nRet = MyClass.EnumCapabilities(pRootItem, 0); 
   if (nRet != WIA_SUCCESS) 
      return FALSE;  
 
   return SUCCESS; 
}