Back to FabImage Library website

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

Ftp_SendFile


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Sends a file to a remote server using FTP (File Transfer Protocol).

Syntax

C++
C#
 
void fil::Ftp_SendFile
(
	const ftl::File& inFilePath,
	const ftl::String& inHostName,
	const ftl::String& inDestinationFileName,
	ftl::Optional<const ftl::String&> inUsername,
	ftl::Optional<const ftl::String&> inPassword,
	bool inUsePassiveMode
)

Parameters

Name Type Default Description
Input value
 inFilePath const File& Path to a file stored on the local drive.
Input value
 inHostName const String& \"ftp://\" URL address of the remote server.
Input value
 inDestinationFileName const String& Path where a file should be saved 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.

Errors

List of possible exceptions:

Error type Description
DomainError Empty destination file name on input in Ftp_SendFile
DomainError Empty file path on input in Ftp_SendFile
DomainError Empty host name on input in Ftp_SendFile