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_DownloadFile

NameFTPit_DownloadFile
Description

This function downloads a file from the FTP Server. You can specify a Full Path, a Relative Path, or a File Name in the Current Remote Directory. To work with the Current Remote Directory, use the FTPit_ChangeRemoteDir function first.

By default, this function will wait until the download is completed before returning control to FileMaker. To make this function download a file in the background, use the CompletedScript parameter to specify a script to call once the download is complete. The script that is called would either call the FTPit_Disconnect function or perform other operations.

If you call this function while the plug-in is uploading or downloading a separate file in the background, the new file will be added to a "queue" of files to be downloaded. When the current file has completed uploading or downloading, the new file will begin to download. You can use the FTPit_GetQueueList function to return the current files that will be uploaded or downloaded.

Return TypeText
FormatFTPit_DownloadFile ( RemoteFile ; CompletedScript ; LocalFile ; AppendToFile ; UseASCIIMode ; CSParameter )
Required Parameters
RemoteFile

The Remote File to Download. (Can be a Full Path, a Relative Path, or a File Name in the Current Remote Directory.)

Optional Parameters
CompletedScript

The Name of a Script to call when the Download is Completed. (If blank, this function will wait until the Download is Complete before returning; Default is blank.)

LocalFile

The Local File to Download the File to. (Can be a Full Path, a Relative Path, or a File Name in the Current Local Directory.) If the file already exists, it will be overwritten. If no file exists with the name, a new file will be created.

AppendToFile

If True and the File Exists, this function will append to the File.

UseASCIIMode

If True, this function will Download the files using ASCII Mode instead of Binary Mode. (Default is False.)

CSParameter

The parameter to send to the completed script.