Zoomed Image

AMSX Scripting Language - Command : FtpGet

Summary

Download a file from an FTP server to the local file system

Description

Connects to an FTP server and downloads the specified remote file. If username or password are not provided, they are read from the "ftpusername" and "ftppassword" special options. The password is decrypted if stored in the UNICODE: encrypted format.

Parameters

ParameterDescription
cmdFTP server address (e.g. "ftp.example.com")
Argument 0Path of the file on the FTP server to download
Argument 1FTP username; leave blank to use the ftpusername special option
Argument 2FTP password; leave blank to use the ftppassword special option (supports UNICODE: encrypted format)
Argument 3FTP port number; leave blank to default to port 21
Argument 4Local file path to write the downloaded file to

Syntax


FtpGet "FTP server address (e.g. "ftp.example.com")", "Path of the file on the FTP server to download", "FTP username; leave blank to use the ftpusername special option", "FTP password; leave blank to use the ftppassword special option (supports UNICODE: encrypted format)", "FTP port number; leave blank to default to port 21", "Local file path to write the downloaded file to"

Return to the AMSX Command Reference