Product Logo

FTPit Pro

Transfer files to and from an FTP server

Functions
FunctionFTPit_AddAccount
FunctionFTPit_Configure
FunctionFTPit_ConfigureAccount
FunctionFTPit_Connect
FunctionFTPit_Disconnect
FunctionFTPit_DownloadDir
FunctionFTPit_DownloadFile
FunctionFTPit_DownloadText
FunctionFTPit_ExportContainer
FunctionFTPit_GetAccountNames
FunctionFTPit_GetAccountOption
FunctionFTPit_GetLastResult
FunctionFTPit_GetQueueList
FunctionFTPit_ImportContainer
FunctionFTPit_IsConnected
FunctionFTPit_LocalChangeDir
FunctionFTPit_LocalChangeDirUp
FunctionFTPit_LocalCopyFile
FunctionFTPit_LocalCurrentDir
FunctionFTPit_LocalDeleteDir
FunctionFTPit_LocalDeleteFile
FunctionFTPit_LocalDirExists
FunctionFTPit_LocalFileExists
FunctionFTPit_LocalFileSize
FunctionFTPit_LocalFileTimestamp
FunctionFTPit_LocalListCount
FunctionFTPit_LocalListItem
FunctionFTPit_LocalMakeDir
FunctionFTPit_LocalMoveFile
FunctionFTPit_LocalPath
FunctionFTPit_LocalReadFile
FunctionFTPit_LocalRenameDir
FunctionFTPit_LocalRenameFile
FunctionFTPit_LocalSelectDirWithDialog
FunctionFTPit_LocalSelectFileWithDialog
FunctionFTPit_LocalWriteFile
FunctionFTPit_QuickDownload
FunctionFTPit_QuickUpload
FunctionFTPit_Register
FunctionFTPit_RemoteChangeDir
FunctionFTPit_RemoteChangeDirUp
FunctionFTPit_RemoteCurrentDir
FunctionFTPit_RemoteDeleteDir
FunctionFTPit_RemoteDeleteFile
FunctionFTPit_RemoteDirExists
FunctionFTPit_RemoteFileExists
FunctionFTPit_RemoteFileSize
FunctionFTPit_RemoteFileTimestamp
FunctionFTPit_RemoteListCount
FunctionFTPit_RemoteListItem
FunctionFTPit_RemoteMakeDir
FunctionFTPit_RemoteRenameDir
FunctionFTPit_RemoteRenameFile
FunctionFTPit_RemoteSendCommand
FunctionFTPit_RemoveAccount
FunctionFTPit_SetAccountOption
FunctionFTPit_StatusWindow
FunctionFTPit_UploadDir
FunctionFTPit_UploadFile
FunctionFTPit_UploadText
FunctionFTPit_Version
FunctionFTPit_VersionAutoUpdate

FTPit_QuickDownload

NameFTPit_QuickDownload
Description

This function allows you to quickly download a single file using an FTP URL format. You just give this function the full URL to the file you want to download, and it connects, downloads, and disconnects for you. The format of the URL is as follows:

ftp://user:pass@domain.com:port/dir/to/file.txt

There are several things that can be defined here, a few of which are optional:

  • Instead of "ftp", you can specify "ftps" to have the plug-in connect with SSL to the FTP server. It will use the equivalent of the "After Connect" setting. If your FTP server requires the "Before Connect" SSL setting to connect on port 990, then specify ":990" after the domain name.
  • The "user" is optional. If it's not there, the plug-in will attempt to connect anonymously to the FTP server.
  • The "pass" is optional if your FTP server does not require a password. If you do need a password, but would rather be prompted for it instead of hard coding it, specify "__ASK__" as the password.
  • The "domain.com" is the domain name or IP address of the FTP server you are trying to connect to. Instead of specifying a domain name, though, you can specify an existing Account name here (defined using the FTPit_AddAccount or FTPit_ConfigureAccount functions). If you specify an Account Name, the plug-in will pull all needed username, password, domain name, etc values from that Account.
  • The "port" is optional and defaults to port 21. If you need to use the "Before Connect" SSL setting, specify 990 here.

Here are some example URLs:

ftp://some.domain.com/some/dir/file.jpg
ftp://bob:secret@some.domain.com/some/dir/file.jpg
ftps://bob:secret@some.domain.com/some/dir/file.jpg
ftps://bob:\_\_ASK\_\_@some.domain.com:990/some/dir/file.jpg
ftp://MyFTPAccount/some/dir/file.jpg
Return TypeText
FormatFTPit_QuickDownload ( URL ; Destination ; ShowStatusWindow )
Required Parameters
URL

The fully qualified URL of the file to Download.

Optional Parameters
Destination

The path to the local destination for the file. [This can be a full path or a path relative to the current local directory. If a file name is specified, the file will be renamed.]

ShowStatusWindow

If True, this function will Show a Status Window.