Back to Aurora Vision Library website
You are here: Start » Function Reference » System » FTP » Ftp_ReceiveString
Ftp_ReceiveString
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | FoundationBasic |
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::Optional<int> inTimeout, bool inAllowUntrusted, const atl::Optional<atl::File>& inCaCertFile, atl::String& outText )
Parameters
Name | Type | Range | 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. | |||
inTimeout | Optional<int> | 0 - | NIL | Request timeout in seconds. | |
inAllowUntrusted | bool | False | Whether or not to allow untrusted SSL certificates. | ||
inCaCertFile | const Optional<File>& | NIL | File holding one or more certificates to verify the peer with. | ||
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 |