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

ftp_rendir_ex

Example: ftp_rendir_ex FTP Vuser Functions (FTP)

Renames a file or directory on the FTP server for a specific session.

int ftp_rendir_ex( FTP *ppftp, char *transaction, <item list>, LAST );
Function objFTP.rendir_ex( ppftp as FTP, transaction as String, item_list as String, LAST ) as Integer
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, "".
<item list> A list of all the items for this function. Enclose all entries with quotes.SOURCE_DIR: The full path of the original file or directory name. TARGET_DIR: The full path of the new file or directory name.ENDITEM - Marks the end of the list. (no quotes)
LAST A marker indicating the end of the argument list.

The ftp_rendir_ex function renames a file or directory on the FTP server for the specified session.

This function is for use with multiple sessions. For global sessions, use the ftp_rendir function, which leaves out the session identifier.

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.