DIRECTORY_DELETE

Use

Deletes the specified directory on the client PC.

Arguments

[IMPORTING] directory TYPE STRING

Path of directory to delete. The path of the directory can either be fully qualified or relative. Environment variables are not supported in the file name.

[CHANGING] rc TYPE I

Return code indicating whether the directory was deleted successfully or not.

Possible values:

  • 0

    directory was deleted successfully

  • 2,3

    the directory does not exist

  • 5

    the user does not have the permissions required to delete the directory.

Exceptions

CNTL_ERROR

Thrown if neither Windows nor Java nor Web GUI is used or the operation is not supported by the GUI used.

DIRECTORY_ACCESS_DENIED

This exception is raised if the client PC user does not have the permission to create the specified directory.

ERROR_NO_GUI

Currently not used.

NOT_SUPPORTED_BY_GUI

Currently not used.

PATH_NOT_FOUND

If the specified directory does not exist, this exception will be thrown.

UNKNOWN_ERROR

UNKNOWN_ERROR is fired if the deletion of the directory fails, the directory exists and the client PC user has the permissions required to delete the directory.

WRONG_PARAMETER

Raised if no directory path is specified.