TWAIN ActiveX/Plug-in Windows/Mac HTTP Control/SDK

SetFileXFERInfo Method

Description

Sets file name and file format information used in File Transfer Mode.

Support information

ActiveX Edition	Plug-in Edition	Mac Edition
Since V1.0	Since V4.0	Since V6.4

Syntax

Boolean ObjectName. SetFileXFERInfo(String FileName, enumTW_FILEFORMAT FileFormat)

Parameters

String FileName: the name of the file to be used in transfer.

enumTW_FILEFORMAT FileFormat: a enumerated values indicates the format of the image.

The followings are the allowed formats: TWFF_TIFF(0), TWFF_PICT(1), TWFF_BMP(2), TWFF_XBM(3), TWFF_JFIF(4), TWFF_FPX(5), TWFF_TIFFMULTI(6), TWFF_PNG(7), TWFF_SPIFF(8), TWFF_EXIF( 9)

Return value

Boolean.

TRUE indicates success. FALSE indicates failure.

When an error occurs and IfThrowException property is TRUE, an exception will be thrown.

When FALSE is returned or an exception is thrown, check ErrorCode property and ErrorString property for error information.

Remarks

The SetFileXFERInfo() is valid only in File Transfer Mode.

Before using any file format, negotiate ICAP_IMAGEFILEFORMAT capability to make sure if the Source can handle the desired image format.

In File Transfer Mode, the image is transferred to the designated file directly and there is no image in Dynamic (Web) TWAIN.