LWia::EnumFormats

#include "ltwrappr.h"

virtual L_INT LWia::EnumFormats(pItem, uFlags)

L_VOID * pItem;	/* pointer to IWiaItem or IWiaItem2 interface */
L_UINT uFlags;	/* reserved for future use, pass 0 */

Enumerates all of the available WIA driver transfer formats.

Parameter	Description
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.
	You can 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.
uFlags	Reserved for future use, pass 0.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This feature is available in LEADTOOLS version 16 or higher.

This function will enumerate all of the available WIA driver transfer formats for the specified acquisition source item.

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.

See Also

Functions:	LWia::EnumCapabilities, LWia::InitSession, LWia::EndSession, Class Members
Topics:	Managing WIA Sources
	WIA Functionality: Property Functions

Example

class CMyWIA : public LWia
{
public:
   L_INT WiaEnumFormatsCB(L_INT nFormatsCount, L_INT nTransferMode, GUID * pFormat);
};
L_INT CMyWIA::WiaEnumFormatsCB(L_INT nFormatsCount, L_INT nTransferMode, GUID * pFormat)
{
   UNREFERENCED_PARAMETER(nFormatsCount);
   UNREFERENCED_PARAMETER(nTransferMode);
   UNREFERENCED_PARAMETER(pFormat);
   // You can do here any kind of checking or handling to the received format.
   return WIA_SUCCESS;
}
L_LTWIASAM_CLIB L_INT LWIA__EnumFormatsExample()
{
   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.EnumFormats(pRootItem, 0);
   if (nRet != WIA_SUCCESS)
      return FALSE; 
   return SUCCESS;
}