deleteVirtualDirectoryFile

deleteVirtualDirectoryFile(filename:         String;
                           deleteIfReadOnly: Boolean): Integer;

The deleteVirtualDirectoryFile method of the JadeRestService class enables you to delete files that are in the directory specified by the VirtualDirectory parameter in the jadehttp.ini file.

The deleteVirtualDirectoryFile method parameters are listed in the following table.

Parameter	Description
filename	Name of the file to be deleted from the virtual directory
deleteIfReadOnly	Deletes files marked as read-only when set to true

This method returns zero (0) if the file deletion is successful or a non-zero error code if it fails.

You can specify whether files created in the virtual directory are deleted automatically and how this happens, by setting the PurgeDirectoryRule parameter in the [application-name] section of the jadehttp.ini file or the PurgeDirectoryRule configuration directive in the JADE mod_jadehttp file. If this parameter or directive is not set, files of type .jpg, .png, or .gif that are more than 12 hours old are removed. For details, see "Internal Housekeeping of the Virtual Directory", in Chapter 2 of the JADE Installation and Configuration Guide.

This method must be called from an end point method that is being executed when called from a REST Services request.

2016.0.01 and higher