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

ftp_dir

Example: ftp_dir FTP Vuser Functions (FTP)

Runs the dir command on the FTP server.

int ftp_dir( char *transaction, <item list>, LAST );

Function objFTP.dir( transaction as String, item_list as String, 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, "".
item_list A list of all the items for this function. Enclose all entries with quotes.
PATH - The full path of the location at which to run the dir command.
OUTPUT (optional) - The path and file name for writing the results of the dir. If this option is not specified, the dir results are saved to the Vuser log file when the Extended log > Data returned by server option is enabled in the Run-Time settings.
PASSIVE (optional) - Sets the communication protocol to Passive Mode FTP. To enable, pass "PASSIVE=TRUE".
ENDITEM - Marks the end of the list. (no quotes)
LAST A marker indicating the end of the argument list.

The ftp_dir function runs the dir command on the FTP server.

This function is for use with global sessions. For multiple sessions, use the ftp_dir_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

The following argument(s) can be parameterized with standard parameterization: List of Attributes