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 FTPDownload( string strFTPServer, string strFTPRemoteFile ) |
| Visual Basic |
|---|
Public Function FTPDownload ( _ strFTPServer As String, _ strFTPRemoteFile As String _ ) As Boolean |
Parameters
- strFTPServer
- Type: System..::..String
The name of the FTP server.
- 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.
Return Value
True indicates success. False indicates failure.
Remarks
Dynamic .NET TWAIN processes the image format according to the extension of the FTPRemoteFile.
Dynamic .NET TWAIN supports the following types of image files:
Bitmap *.bmp, *.dib
JPEG *.JPG, *.JPEG, .*.JPE, *.JFIF
TIFF *.TIF, *.TIFF
PNG *.PNG
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. |