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_SetAccountOption

NameFTPit_SetAccountOption
Description

This function sets specific options in the Account you specify.

Return TypeText
FormatFTPit_SetAccountOption ( AccountName ; OptionName ; OptionValue )
Required Parameters
AccountName

The Name of the Account to Modify.

OptionName

The Name of the Option to Modify. The following is a list of the valid option names you can specify:

  • Host - The domain name or IP address of the FTP server for this account.
  • Username - The Username to use when connecting to the FTP server.
  • Password - The Password to use when connecting to the FTP server.
  • SecureType - The type of secure connection to use when connecting to the FTP Server. Possible values are None, SSH, AfterConnect (also known as Explicit), and BeforeConnect (also known as Implicit). This OptionName was previously “TLSType”.
  • Port - An alternate Port to use to connect to the FTP server for this account.
  • Timeout - A Timeout setting in seconds to wait for the FTP server to respond to commands.
  • PromptForPassword - Specifies whether or not FTPit Pro should Prompt the user for their Password instead of storing it with the rest of the Account information.
  • DataPortRangeStart - Starting TCP/IP Port number for the Data Port Connection. This is an advanced setting for when you must connect to the internet through a firewall. You will most likely never need to use this.
  • DataPortRangeEnd - Ending TCP/IP Port number for the Data Port Connection. This is an advanced setting for when you must connect to the internet through a firewall. You will most likely never need to use this.
  • Passive - Specifies if the connection type is Passive or not. Value is a boolean. Specify “1” for True or “0” for false. You can also use True/Yes/On or False/No/Off.
  • DefaultCompletedScript - The name of the script that is used as the default for when FTPit Pro has completed a transfer.
  • DefaultMode - Specifies whether transfers are done in “ASCII” or “Binary” mode by default.
  • SSLVerifyPeer - Specifies whether the plug-in will verify the server certificate has been signed by a known certificate authority. Turning this off is considered unsafe. Value is a boolean. Specify “1” for True or “0” for false. You can also use True/Yes/On or False/No/Off.
  • SSLVerifyHost - Specifies whether the plug-in will verify the host you are connecting to is the host defined in the SSL certificate returned by the server. Turning this off is considered unsafe. Value is a boolean. Specify “1” for True or “0” for false. You can also use True/Yes/On or False/No/Off.

OptionValue

The New Value for the Option.

Examples
Example 1

Sets the "Host" Option of the "work ftp" Account to "ftp.mydomain.com".

FTPit_SetAccountOption( "work ftp" ; "Host" ; "ftp.mydomain.com" )
Example 2

Turns off the Passive Option for the "work ftp" Account.

FTPit_SetAccountOption( "work ftp" ; "Passive" ; "Off" )