Back to FabImage Library website

You are here: Start » Function Reference » System » FTP » Ftp_ReceiveImage

Ftp_ReceiveImage


Header: FIL.h
Namespace: fil
Module: FoundationLite

Downloads an image from a remote server using FTP (File Transfer Protocol).

Syntax

C++
C#
 
void fil::Ftp_ReceiveImage
(
	const ftl::String& inHostName,
	const ftl::String& inFtpFilePath,
	ftl::Optional<const ftl::String&> inUsername,
	ftl::Optional<const ftl::String&> inPassword,
	bool inUsePassiveMode,
	ftl::Optional<int> inTimeout,
	bool inAllowUntrusted,
	const ftl::Optional<ftl::File>& inCaCertFile,
	bool inLoadAlphaChannel,
	fil::Image& outImage
)

Parameters

Name Type Range Default Description
Input value inHostName const String& \"ftp://\" URL address of the remote server.
Input value inFtpFilePath const String& Location of the file on a remote server.
Input value inUsername Optional<const String&> NIL User name needed to log in.
Input value inPassword Optional<const String&> NIL Password associated with a user name.
Input value inUsePassiveMode bool Protocol communication mode. May be necessary when using a firewall.
Input value inTimeout Optional<int> 0 - NIL Request timeout in seconds.
Input value inAllowUntrusted bool False Whether or not to allow untrusted SSL certificates.
Input value inCaCertFile const Optional<File>& NIL File holding one or more certificates to verify the peer with.
Input value inLoadAlphaChannel bool Whether to load the alpha channel (if exists) as an additional image channel.
Output value outImage Image& Image downloaded from the remote server.

Errors

List of possible exceptions:

Error type Description
DomainError Empty ftp file path on input in Ftp_ReceiveImage
DomainError Empty host name on input in Ftp_ReceiveImage