Download File From FTP
Downloads a file from a FTP location to a configured path and file name.
Privileges
Normal
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| Host | String | Yes | The name of the host of the FTP site. |
| User | String | Yes | The user name to be used in making the FTP connection. |
| Password | String | Yes | The password to be used in making the FTP connection. |
| Remote File | String | Yes | The file name of the file to be downloaded. |
| Save As | String | Yes | The file name to use when saving the downloaded file. |
| Overwrite Existing File | Selection | Yes | Determines that an existing file with the same name and location should be overwritten. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| Result | Number | Returns a success value of zero or any value other than zero to indicate failure. |
Example Input Parameters
| Name | Type | Required | Example |
|---|---|---|---|
| Host | String | Yes | ftp://ftp_site.ABC.com |
| User | String | Yes | Jsmith |
| Password | String | Yes | Password!@# |
| Remote File | String | Yes | File1.txt |
| Save As | String | Yes | C:\folder1\file1.txt |
| Overwrite Existing File | Selection | Yes | Optionally, you can overwrite the file on the device if it already exists |