FTPDownloadEx Method

Description

Downloads an image from the FTP server.

ActiveX Edition	Plug-in Edition	Mac Edition
Since V5.0	Since V5.0	Since V6.4

Syntax

Boolean ObjectName. FTPDownloadEx(String FTPServer, String FTPRemoteFile, Long ImageType)

Parameters

String FTPServer: the name of the FTP server.

String FTPRemoteFile: the name of the file to be downloaded. It should be the relative path of the file on the FTP server.

Long ImageType: the image format of the file to be downloaded.

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

Dynamic Webcam processes the image format according to the value of the ImageType.

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 Webcam, just as it is acquired from a webcam.

See also

FTPUserName property, FTPPassword property, FTPPort property, ProxyServer property, FTPUploadEx(), FTPDownload(), HTTPPort property, HTTPUserName property, HTTPPassword property, HTTPDownloadEx(), HTTPUploadThroughPutEx(), HTTPUploadThroughPostEx()

Sample

A JavaScript sample is provided.

	function btnFTPDownloadEx_onclick() {
		Webcam.FTPDownload("192.168.1.20", "/Webcam/Images/ImageData.jpg",1);
	}
	
</script>