ftp_rmdir

FTP Functions (ftp)

Removes a directory on the FTP server.

int ftp_rmdir( const char *transaction, const char *path );
int objFTP.rmdir( transaction as String, path as String ) as Integer     `for VB Script
transactionA transaction name for this step. To instruct VuGen not to create a transaction for this step, use a NULL string, "".
pathThe path of the directory to remove, in the following format:"PATH=full path"

The ftp_rmdir function removes a directory on the FTP server.

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

Example

In the following example, the ftp_rmdir function removes the for_jon directory from the FTP server.

// Remove the for_jon directory.
ftp_rmdir("Ftp_Rmv", "PATH=/pub/for_jon" );