Share this page

# ftp_set_option

FTP Functions (ftp)

Sets options for an FTP session.

    int ftp_set_option( FTP *ppftp, const char *transaction, [options,] LAST );

    int objFTP.set_option( ppftp as FTP, transaction as String, options as String ) as Integer     `for VB Script

ppftp | An FTP session identifier.
transaction | A transaction name for this step. To instruct VuGen not to create a transaction for this step, use a NULL string, "".
options | An optional comma-separated list of options. The order of options may affect the result. The following options are supported: `"SSL_ON_DATA=<TRUE|FALSE>"` Enables or disables SSL on the data connection. `"SSL_ON_CONTROL=FALSE"` Disables SSL on the control connection.

ftp_set_option sets FTP options for a specific session.

To enable SSL on a control connection use the ftp_logon or ftp_logon_ex functions.

The server may reject subsequent ftp_set_option calls for enabling SSL on a data connection after disabling SSL on the control connection. Therefore, order of options can be critical.

## Return Values

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

## Parameterization

All string input arguments can be passed using standard parameterization.

## Example

In the following example, the ftp_set_option function disables SSL on the data and control connections.

    ftp_set_option(&ftp1, "FtpSetOption", "SSL_ON_DATA=FALSE", "SSL_ON_CONTROL=FALSE", LAST );;

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: