Back to Adaptive Vision Library website
You are here: Start » Function Reference » FTP » Ftp_ReceiveString
Ftp_ReceiveString
Downloads a text string from a remote server using FTP (File Transfer Protocol).
Syntax
C++
C#
void avl::Ftp_ReceiveString ( const atl::String& inHostName, const atl::String& inFtpFilePath, atl::Optional<const atl::String&> inUsername, atl::Optional<const atl::String&> inPassword, bool inUsePassiveMode, atl::String& outText )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inHostName | const String& | \"ftp://\" | URL address of the remote server. | |
inFtpFilePath | const String& | Location of the file 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. | ||
outText | String& | Text read from a remote server. |
Errors
Error type | Description |
---|---|
DomainError | Empty host name on input in Ftp_ReceiveString |
DomainError | Empty ftp file path on input in Ftp_ReceiveString |