Back to FabImage Library website

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

Ftp_ReceiveString


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Downloads a text string from a remote server using FTP (File Transfer Protocol).

Syntax

C++
C#
 
void fil::Ftp_ReceiveString
(
	const ftl::String& inHostName,
	const ftl::String& inFtpFilePath,
	ftl::Optional<const ftl::String&> inUsername,
	ftl::Optional<const ftl::String&> inPassword,
	bool inUsePassiveMode,
	ftl::String& outText
)

Parameters

Name Type 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.
Output value
 outText String& Text read from a remote server.

Errors

List of possible exceptions:

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