Downloads an image from the FTP server.
Namespace: Dynamsoft.DotNet.TWAINAssembly: DynamicDotNetTWAIN (in DynamicDotNetTWAIN.dll) Version: 3.0.0.0 (3.0.0.0)
Syntax
| C# |
|---|
public bool FTPDownloadEx( string strFTPServer, string strFTPRemoteFile, DWTImageFileFormat enumImageType ) |
| Visual Basic |
|---|
Public Function FTPDownloadEx ( _ strFTPServer As String, _ strFTPRemoteFile As String, _ enumImageType As DWTImageFileFormat _ ) As Boolean |
Parameters
- strFTPServer
- Type: System..::..String
- strFTPRemoteFile
- Type: System..::..String
The name of the file to be downloaded. It should be the relative path of the file on the FTP server.
- enumImageType
- Type: Dynamsoft.DotNet.TWAIN.Enums..::..DWTImageFileFormat
The image format of the file to be downloaded.
Return Value
True indicates success. False indicates failure.
Remarks
Dynamic .NET TWAIN processes the image format according to the value of the ImageType.
DWTImageFileFormat Allowed Values ImageType
0 BMP
1 JPEG
2 TIFF
3 PNG
4 PDF
FTPRemoteFile parameter should include the FTP directory of the file.
The image downloaded will be displayed in Dynamic .NET TWAIN,
just as it is acquired from a TWAIN Data Source.
Exceptions
| Exception | Condition |
|---|---|
| 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. |