Start » Filter Reference » System » FTP » Ftp_ReceiveString
Basic| Module: | FoundationBasic |
|---|
Downloads a text string from a remote server using FTP (File Transfer Protocol).
| Name | Type | Description | |
|---|---|---|---|
 |
inHostName | String | URL address of the remote server. |
|
inFtpFilePath | String | Location of the file on a remote server. |
|
inUsername | String* | User name needed to log in. |
|
inPassword | String* | 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
This filter can throw an exception to report error. Read how to deal with errors in Error Handling.
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 |
Complexity Level
This filter is available on Basic Complexity Level.
Disabled in Lite Edition
This filter is disabled in Lite Edition. It is available only in full, Aurora Vision Studio Professional version.
Filter Group
This filter is member of Ftp_Download filter group.