LWIAACQUIREOPTIONS

Summary

The LWIAACQUIREOPTIONS structure provides information about the options that affect the acquisition process.

Syntax

typedef struct _LWIAACQUIREOPTIONS 
{ 
   L_UINT uStructSize; 
   L_UINT uMemBufSize; 
   L_BOOL bDoubleBuffer; 
   L_BOOL bOverwriteExisting; 
   L_BOOL bSaveToOneFile; 
   L_BOOL bAppend; 
   L_TCHAR szFileName[MAX_PATH]; 
} LWIAACQUIREOPTIONS, * pLWIAACQUIREOPTIONS; 

Members

uStructSize

Size of this structure in bytes, for versioning. Use the sizeof() operator to calculate this value.

✎ NOTE

This member is ignored when using WIA version 2.0.

uMemBufSize

The size in bytes of the buffer that is used for the memory data transfer when the transfer mode is Memory transfer mode.

✎ NOTE

This member is ignored when using WIA version 2.0.

bDoubleBuffer

Flag indicating whether to use double buffering while doing memory transfer. Possible values are:

✎ NOTE

This member is ignored when using WIA version 2.0.

bOverwriteExisting

Flag that indicates whether to save a multiple pages to a single file. Possible values are:

✎ NOTE

This member is ignored when using WIA version 2.0.

bSaveToOneFile

Flag that indicates whether to save all acquired pages into a single file. Possible values are:

✎ NOTE

This member is ignored when using WIA version 2.0.

bAppend

Flag that indicates whether to append the acquired page(s) to the end of an existing file that supports multipage. Possible values are:

✎ NOTE

This member is ignored when using WIA version 2.0.

szFileName

Character string that contains the file name used in the file transfer mode. Use this member only if the nTransferMode member is set to TYMED_FILE.

Comments

This feature is available in LEADTOOLS version 16 or higher.

pLWIAACQUIREOPTIONS is a pointer to a LWIAACQUIREOPTIONS structure. If the function parameter type is pLWIAACQUIREOPTIONS, you can declare a LWIAACQUIREOPTIONS variable, update the structure's fields and pass the variable's address in the parameter. Declaring a pLWIAACQUIREOPTIONS variable is necessary only if your program requires a pointer.

If the nTransferMode member value is set to TYMED_CALLBACK, the acquire functions will use the memory buffers received from the scanner and generate a BITMAPHANDLE as a result.

This generated BITMAPHANDLE will be returned in the pBitmap parameter of LWIAACQUIRECALLBACK callback when it is fired by calling the L_WiaAcquire or L_WiaAcquireSimple functions.

If the bSaveToOneFile member is set to FALSE and also the bOverwriteExisting member is set to FALSE, the acquire functions will generate a new file for each acquired page from the device by generating new names of the name you specified through the szFileName member by adding "(N)" to the end of the file name where N represents an incremented number and if the new name already exists it will keep generating new name until it finds a new one. If the bOverwriteExisting member is set to TRUE then the acquire functions will generate a new name and check whether it exists. If it does it overwrites that file.

Note

If the L_WIA_SHOW_USER_INTERFACE flag is set for the uFlags member of any of the acquire functions while you are using WIA 2.0 then all members of this structure except the szFileName member are ignored since WIA 2.0 acquire dialog has its own way of acquiring to file(s). If you are using WIA version 2.0 then you only need to fill the destination file name member of this structure.

But if you do not wish to show the manufacturers image acquisition dialog while acquiring from the scanner by not specifying this flag then you can use all of this structure members even with WIA 2.0.

Usage

• L_WiaAcquire
• L_WiaAcquireSimple
• L_WiaAcquireToFile