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

Namespace: Dynamsoft.DotNet.TWAIN
Assembly: DynamicDotNetTWAIN (in DynamicDotNetTWAIN.dll) Version: 3.0.0.0 (3.0.0.0)

Syntax

C#
public bool SetFileXFERInfo(
	string strFileName,
	TWICapFileFormat enumFileFormat
)
Visual Basic
Public Function SetFileXFERInfo ( _
	strFileName As String, _
	enumFileFormat As TWICapFileFormat _
) As Boolean

Parameters

strFileName
Type: System..::..String
The name of the file to be used in transfer.
enumFileFormat
Type: Dynamsoft.DotNet.TWAIN.Enums..::..TWICapFileFormat
TWICapFileFormat type: 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

True indicates success. False indicates failure.

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 .NET TWAIN.

Exceptions

ExceptionCondition
Dynamsoft.DotNet.TWAIN..::..TwainException When an error occurs and IfThrowException property is true, an exception will be thrown. When IfThrowException property is false, please check ErrorCode and ErrorString.

See Also