Back to FabImage Studio website

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

Ftp_ReceiveImage

Basic

Module: FoundationBasic

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

Name Type Description
Input value
 inHostName String URL address of the remote server.
Input value
 inFtpFilePath String Location of the file on a remote server.
Input value
 inUsername String* User name needed to log in
Input value
 inPassword String* Password associated with a user name.
Input value
 inUsePassiveMode Bool Protocol communication mode. May be necessary when using a firewall.
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

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

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

Complexity Level

This filter is available on Basic Complexity Level.

Disabled in Lite Edition

This filter is disabled in Lite Edition. It is available only in full, FabImage Studio Professional version.

Filter Group

This filter is member of Ftp_Download filter group.