<CFFTP ACTION="action"
    USERNAME="name"
    PASSWORD="password"
    SERVER="server"
    TIMEOUT="timeout in seconds"
    PORT="port"
    CONNECTION="name"
    AGENTNAME="name"
    PROXYSERVER="proxyserver"
    PROXYBYPASS="proxybypass"
    RETRYCOUNT="number"
    STOPONERROR="Yes/No">

Use this form of the CFFTP tag to establish a connection with an FTP server.

If you use connection caching to an already active FTP connection, you don't need to respecify the connection attributes:

Note

Changes to a cached connection, such as changing RETRYCOUNT or TIMEOUT values, may require reestablishing the connection.

ACTION

Required. Determines the FTP operation to perform. To create an FTP connection, use Open. To terminate an FTP connection, use Close (with no other attributes except an optional connection name).

USERNAME

Required for Open. User name to pass in the FTP operation.

PASSWORD

Required for Open. Password to log the user.

SERVER

Required for Open. The FTP server to connect to, as in ftp.myserver.com

TIMEOUT

Optional. Value in seconds for the timeout of all operations, including individual data request operations. Defaults to 30 seconds.

PORT

Optional. The remote port to connect to. Defaults to 21 for FTP.

CONNECTION

Optional. The name of the FTP connection. Used to cache the current FTP connection or to reuse connection information from a previous connection of the same name. All calls to CFFTP with the same connection name will reuse the same FTP connection information.

AGENTNAME

Optional. Application or entity conducting transfer.

PROXYSERVER

Optional. A string that contains the name of the proxy server (or servers) to use if proxy access was specified. If this parameter is NULL, the tag reads proxy information from the registry.

PROXYBYPASS

Optional. An optional list of host names or IP addresses, or both, that are known locally. Requests to these names are not routed through the proxy. The list can contain wildcards, such as "157.55.* *int*", meaning any IP address starting with 157.55, or any name containing the substring "int", will bypass the proxy. If this parameter specifies the "<local>" macro as the only entry, the tag bypasses any host name that does not contain a period. For example, "www.microsoft.com" is routed to the proxy, whereas "internet" is not. If this parameter is NULL, the tag reads the bypass list from the registry.

RETRYCOUNT

Optional. Number of retries until failure is reported. Default is one (1).

STOPONERROR

Optional. Yes or No. When Yes, halts all processing and displays an appropriate error. Default is Yes.

When No, three variables are populated: