FTPit Pro

Transfer files to and from an FTP server

<- Back to FTPit Pro function list

FTPit_GetAccountOption

Description

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

Return Type
Varies
Format
FTPit_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.
Related Items
FTPit_AddAccount, FTPit_ConfigureAccount, FTPit_RemoveAccount, FTPit_SetAccountOption
Examples

Example 1

Code:

FTPit_GetAccountOption("work ftp";"Host")

Result:

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

Example 2

Code:

FTPit_GetAccountOption("work ftp";"Passive")

Result:

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