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_GetAccountOption

NameFTPit_GetAccountOption
Description

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

Return TypeVaries
FormatFTPit_GetAccountOption ( AccountName ; OptionName )
Required Parameters
AccountName

The Name of the Account to return the Option from.

OptionName

The Name of the Option to return. The following are valid OptionNames:

  • 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.
  • TLSType - The type of SSL/TLS connection to use when connecting to the FTP Server.
  • 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.
  • 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.
Examples
Example 1

This returns the Domain Name or IP Address of the ftp server for the "work ftp" account.

FTPit_GetAccountOption( "work ftp" ; "Host" )
Example 2

This would return 1 if the Account is set to use Passive mode or 0 if Passive mode is turned off.

FTPit_GetAccountOption( "work ftp" ; "Passive" )