FTP Vuser Functions (FTP) > Alphabetical List of Functions > ftp_set_option


Example: ftp_set_option FTP Vuser 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, "".

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.


All string input arguments can be passed using standard parameterization.