Function Reference The Function Reference is a complete reference for FTPit Pro functions. Click on a function title to view more information which includes the function description, parameter information, example usage and more.	Function Reference Browser The Function Reference Browser offers better navigation for the FTPit Pro functions, you can Launch Function Browser in a new window.

Function Reference

• FTPit_AddAccount

  This function adds a new account with the specified name. You can create accounts within the plug-in that contain different FTP server information. After creating accounts, you can use the... read more

• FTPit_ChangeLocalDir

  This function changes the "current" local directory to the path that you... read more

• FTPit_ChangeLocalDirUp

  This function provides a quick way to change to the parent directory of the current local directory. For example, if the current local directory is "c:\myfiles\downloads\" or "Macintosh... read more

• FTPit_ChangeRemoteDir

  This function changes the "current" remote directory to the path that you... read more

• FTPit_ChangeRemoteDirUp

  This function is a short cut to changing the current remote directory to its parent directory. For example, if the current remote directory is "/pub/downloads/", after calling this function, the... read more

• FTPit_Configure

  Calling this function with no parameters will open the FTPit Pro Configuration Dialog. You can optionally open to a specific tab by specifying the name of the tab as the "Option" parameter. This... read more

• FTPit_ConfigureAccount

  This function opens the Account Configuration Dialog for setting up an Account. If you do not specify an Account Name, the dialog will allow you to edit any of the currently defined Accounts as well... read more

• FTPit_Connect

  This function opens a connection to the FTP server set in the account you specify. After using this function, use FTPit_ChangeLocalDir/FTPitChangeRemoteDir to set the current directories, and then... read more

• FTPit_CopyLocalFile

  You can use this function to copy a local file to a new... read more

• FTPit_DeleteLocalFile

  This function allows you to delete a file from your local... read more

• FTPit_DeleteRemoteFile

  Use this function to delete a remote... read more

• FTPit_Disconnect

  This function closes the connection to the FTP... read more

• FTPit_DownloadDir

  The DownloadDir function will download a complete directory of files from an FTP server to your computer. If the "Recursive" parameter is set to True, it will also download all subdirectories. The... read more

• FTPit_DownloadFile

  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... read more

• FTPit_DownloadText

  This function works like the FTPit_DownloadFile function, except instead of downloading the file to the hard drive, it returns the file data to the field/variable you are setting. You should only use... read more

• FTPit_ExportContainer

  This function will export a file from a container to a specified... read more

• FTPit_GetAccountNames

  This function returns the Names of all currently defined... read more

• FTPit_GetAccountOption

  This function retrieves specific options out of the account you specify.... read more

• FTPit_GetCurrentLocalDir

  This function returns the current local... read more

• FTPit_GetCurrentRemoteDir

  This function returns the current remote directory. This function is useful if the FTP server you log into automatically redirects you to your home directory. It is also useful if you are connected... read more

• FTPit_GetLastResult

  This function gives you information about the transfer the plug-in just completed or the error that... read more

• FTPit_GetLocalFileSize

  This function gives the size of a file on your local computer. The size returned is in bytes. To convert this to Kilobytes (KB) divide by 1024. To convert to Megabytes (MB), divide by 1048576. ... read more

• FTPit_GetLocalListCount

  This function returns the number of items in the Local Directory. This includes files, folders, and hidden items (e.g. hidden files, ".", "..", and etc). Note: To set the Local Directory, call the... read more

• FTPit_GetLocalListItem

  Use this function to get a list of all the items in the Local Directory. Use the FTPit_ChangeLocalDir function to set the Local Directory prior to calling this function. Setting the Which parameter... read more

• FTPit_GetLocalNamedPath

  You can use this function to retrieve a variety of paths including: Database - The Path to the Folder containing the Current Database. FileMaker - The Path to the Folder containing the... read more

• FTPit_GetQueueList

  This function returns a list of the files you have queued for upload or download. You can queue multiple files for upload or download with multiple calls to FTPit_DownloadFile, FTPit_DownloadText,... read more

• FTPit_GetRemoteFileSize

  This function gives the size of a file on the FTP server. The size returned is in bytes. To convert this to Kilobytes (KB) divide by 1024. To convert to Megabytes (MB), divide by 1048576. Finally,... read more

• FTPit_GetRemoteListCount

  This function returns the number of items in the Remote Directory. This includes files, folders, and hidden items (e.g. hidden files, ".", "..", and etc). Note: to set the Remote Directory, call... read more

• FTPit_GetRemoteListItem

  Use this function to get a list of all the items in the Remote Directory. Use the FTPit_ChangeRemoteDir function to set the Remote Directory prior to calling this function. Setting the Which... read more

• FTPit_ImportContainer

  This function allows you to import a file from your hard drive into a container field in your database. The file can either be imported and stored in the actual database file (ByReference parameter... read more

• FTPit_IsConnected

  Use this function to determine whether you are connected to your FTP site. The function will return "1" if you are connected, and "0" if you are not... read more

• FTPit_LocalDirExists

  This function tests for the Existence of a Directory on your hard drive.... read more

• FTPit_LocalFileExists

  This function tests for the Existence of a File on your hard drive.... read more

• FTPit_MakeLocalDir

  This function creates a Directory on your hard drive.... read more

• FTPit_MakeRemoteDir

  Use this function to create a new Directory on the FTP server. ... read more

• FTPit_MoveLocalFile

  This function allows you to move a file on your local hard drive to a new location. To rename the file at the same time, specify the name in the DesinationDirOrFile parameter. To work with the... read more

• FTPit_QuickDownload

  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... read more

• FTPit_QuickUpload

  This function allows you to quickly upload a single file using an FTP URL format. You just give this function the file or container you want to upload and the full URL to the location you want to... read more

• FTPit_Register

  You can use this function to Register the plug-in from a script instead of through the Configuration Dialog. This is useful when the plug-in is being distributed to many computers, allowing you to... read more

• FTPit_RemoteDirExists

  This function tests for the Existence of a directory on the FTP... read more

• FTPit_RemoteFileExists

  This function tests for the Existence of a File on the FTP... read more

• FTPit_RemoveAccount

  This function removes an Account with the specified name. You can also remove Accounts from the Account Configuration Dialog available from the FTPit_ConfigureAccount... read more

• FTPit_RemoveLocalDir

  This function allows you to delete a folder from your local computer. Note, the folder must be empty before it can be deleted. ... read more

• FTPit_RemoveRemoteDir

  This function allows you to delete a directory on the FTP server. In general, FTP sites will not allow you to delete a directory if there are files in the directory; you would need to delete all the... read more

• FTPit_RenameLocalFile

  Use this function to rename a file on your local... read more

• FTPit_RenameRemoteFile

  Use this function to rename a file on the FTP... read more

• FTPit_SelectLocalDirWithDialog

  This function will display a folder chooser dialog which will allow you to select a local folder and the function will return the path to that folder. You can set the location to open the dialog to,... read more

• FTPit_SelectLocalFileWithDialog

  This function will display a file chooser dialog which will allow you to select a local file and the function will return the path to that file. You can set the location to open the dialog to, as... read more

• FTPit_SendRemoteCommand

  This function is used to send FTP Commands directly to the FTP Server. If FTPit Pro doesn't have a specific function to do what you need, it may be possible to use this function to send your... read more

• FTPit_SetAccountOption

  This function sets specific options in the Account you... read more

• FTPit_StatusWindow

  Use this function to show a status window that displays information about what the plug-in is currently doing. When you are transferring a file, the status window will show you what it is currently... read more

• FTPit_UploadDir

  The UploadDir function will upload a complete directory of files from your computer to an FTP server. If the "Recursive" parameter is set to True, it will also upload all subdirectories. The... read more

• FTPit_UploadFile

  This function uploads 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... read more

• FTPit_UploadText

  This function works like the FTPit_UploadFile function, except instead of uploading an existing file to the FTP server, it creates a text file with the specified text data and uploads that to the... read more

• FTPit_Version

  This function returns the current version of FTPit Pro. This function is useful for testing whether or not the plug-in is installed and enabled. If you call this function and a question mark ("?")... read more

• FTPit_VersionAutoUpdate

  This function returns an Auto Update friendly Version number of FTPit Pro. The format of this version number is always exactly 8 digits long. The first two digits represent the major version of the... read more