You are here: Start » Function Reference » FTP » Ftp_SendImage

Ftp_SendImage

Header:	FIL.h
Namespace:	fil

Sends an image to a remote server using the FTP (File Transfer Protocol)

Syntax

void fil::Ftp_SendImage
(
	const fil::Image& inImage,
	ftl::Optional<fil::ImageFileFormat::Type> inImageFileFormat,
	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
inImage	const Image&		Image to send.
inImageFileFormat	Optional<ImageFileFormat::Type>	NIL	If Nil the format will be chosen on the basis of extension
inHostName	const String&	\"ftp://\"	URL address of the remote server.
inDestinationFileName	const String&		Path where an image file should be saved on a remote server.
inUsername	Optional<const String&>	NIL	User name needed to log in.
inPassword	Optional<const String&>	NIL	Password associated with a user name.
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_SendImage
DomainError	Empty host name on input in Ftp_SendImage