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_Configure

NameFTPit_Configure
Description

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 function also allows you to get or set any preference found in the Configuration Dialog.

Valid PrefNames:

“AddHelp” - If True, Function specific Help will be added to Calculations when inserting the Plug-in’s Functions.
“UseOldFunctions” - If True, the old-style External(“doFTP-XXX”) functions will be available.
“UseNewFunctions” - If True, the new-style FTPit_XXX functions will be available.

Return TypeVaries
FormatFTPit_Configure ( Option ; PrefName ; PrefValue )
Optional Parameters
Option

Specify the name of a Tab in the Configuration Dialog to show it opened to that tab.
Specify “Get” with the PrefName parameter to get a preference value. (If not found, and PrefValue is defined, PrefValue will be returned.)
Specify “Set” with the PrefName and PrefValue parameters to set a preference value.

PrefName

The Name of the Preference to Get or Set. (See the Function Description for a list of valid PrefNames.)

PrefValue

The Value of the Preference to Set. (See the Function Description for some possible values.)

Examples
Example 1

Opens the FTPit Pro Configuration Dialog. (Because the "Option" parameter is not used, the dialog will open to the "Basics" tab.)

FTPit_Configure
Example 2

Opens the FTPit Pro Configuration Dialog to the "About" tab.

FTPit_Configure( "About" )
Example 3

Returns the value of the 'Add Help Comments to External Functions' setting from the Configuration Dialog.

FTPit_Configure( "Get" ; "AddHelp" )
Example 4

Sets the 'Add Help Comments to External Functions' setting in the Configuration Dialog to false.

FTPit_Configure( "Set" ; "AddHelp" ; "False" )