Share this page

# ftp_logon

FTP Functions (ftp)

Performs a login to an FTP server.

    int ftp_logon( char *transaction, char *url, [attributes,] LAST );

Function objFTP.logon( transaction as String, url as String, ByVal attributes As Variant, LAST ) as Integer ` for VB Script

transaction | A transaction name for this step. To instruct VuGen not to create a transaction for this step, use a NULL string, "".
URL | The URL of the FTP server: "URL=ftp path" The ftp path should have the following format: ftp[s]://[username:[password]@][server[:port]]The use of `ftps` protocol indicates that the control connection is protected by SSL. However, even if the protocol is `ftp,` the control connection may be still SSL protected by using AUTH TLS (or similar) attributes
attributes | An optional comma-separated list. The following attributes are supported:"LocalAddr=<local_ip:port> A local address for IP spoofing. "LocalAddressIndex=<number> The index of the local address for IP spoofing. "ClientCert=<path> The path to the client certificate pem file. "ClientKey=<path to private key pem file. "ClientPassword=<password> For the private key. "ClientCiphers=<c1[:c2][...<:cN]> A colon-delimited list of the client ciphers. "CertificateAuthority=<directory> The directory containing the certificates of authority. "AUTH TLS" Activates SSL on the control connection. "AUTH TLS-C" Activates SSL on the control connection. "AUTH SSL" Activates SSL on the control connection.
LAST | A marker indicating the end of the argument list.

The ftp_logon function performs a login to an FTP server.

This function is for use with global sessions. For multiple sessions, use the ftp_logon_ex function, which allows you to specify a session identifier.

## Return Values

If this function succeeds, it returns LR_PASS. Otherwise, it returns LR_FAIL.

## Parameterization

Standard parameterization is not available for this function.

## Example

In this example, the ftp_logon function logs on to an FTP server.

        // Logon to the FTP server

        ftp_logon("FTP", "URL=ftp://ftp.abc.com", LAST );

        // Logout from the FTP server

Tips to improve your search results... VuGen Function Reference Version 26.1 Function Reference 26.1 All View Local Help Center View Online Help Center Version: