TRANSFEROPTIONS

typedef struct _tagTransferOptions
{
   L_UINT uStructSize; 
   TWAIN_TRANSFER_MODES TransferMode; 
   L_TCHAR szFileName[L_MAX_PATH]; 
   L_UINT uFileFormat; 
   L_UINT uCompType; 
} TRANSFEROPTIONS, L_FAR * pTRANSFEROPTIONS;

The TRANSFEROPTIONS structure provides information about transfer options to be used in the acquisition process.

Member

Description

uStructSize

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

TransferMode

Specifies the transfer mode. For possible values, refer to the TWAIN_TRANSFER_MODES enumeration.

szFileName

Character string that contains the file name to transfer if the TransferMode is set to TWAIN_TRANSFER_FILE flag.

uFileFormat

The file format to transfer if the TransferMode is set to TWAIN_TRANSFER_FILE flag. For more information about the supported file formats, refer to the Formats of Input Files.

uCompType

The compression type to be used if the TransferMode is set to TWAIN_TRANSFER_MEMORY flag.

Comments

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

TRANSFEROPTIONS is used with the LTwain::SetTransferOptions and LTwain::GetTransferOptions functions.