Share this page

# ftp_delete_ex

FTP Functions (ftp)

Deletes a file from an FTP server for a specific session.

    int ftp_delete_ex( FTP *ppftp, char *transaction, <item list>, LAST );

Function objFTP.delete_ex( ppftp as FTP, transaction as String, item_list as String, LAST ) 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, "".
item_list | A list of all the items for this function. Enclose all entries with quotes. Specify either PATH or MPATH. PATH = "<path> - The full pathname of the file to be deleted, relative to the root directory of the FTP server. MPATH = " "<path> - The pathname of the files to be deleted, using wildcards to specify multiple files. If wildcards are not used, all files in the MPATH are deleted. Wildcard behavior is determined by the FTP server software. If the argument contains wildcards, make sure you test your script on each FTP version you are going to run tests on. Close the item list with ENDITEM. No quotes.
LAST | A marker indicating the end of the argument list.

The ftp_delete_ex function deletes a file or files from an FTP server for the specified session.

This function is for use with multiple sessions. For global or single sessions, use the ftp_delete function, which does not require the session identifier.

## Return Values

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

## Parameterization

The values of keyword-value pairs can be parameterized. For example, "ALT={altParam}".

## Example

In the following example, the ftp_delete_ex function deletes the ftp_file.txt file from the FTP server for the session ftp.

Copy code

    FTP pFTP;
    // Logon to the FTP server
    ftp_logon_ex (&pFTP,"FTP", "URL=ftp://ftp.microsoft.com",
         LAST );
    // Delete the file from the FTP server
    ftp_delete_ex (&pFTP, "Ftp_Delete",
                "PATH=/pub/for_jon/ftp_file.txt",
                ENDITEM,
                LAST );
    // Logout from the FTP server
    ftp_logout_ex(&pFTP);

Tips to improve your search results... VuGen Function Reference Version 26.1-26.3 Function Reference 26.1-26.3 All View Local Help Center View Online Help Center Version: