CMISDeleteFolder

Deletes a folder on the CMIS server.

Member of namespace

CMISClient

Syntax

bool CMISDeleteFolder(string cmisDirectoryPath, bool ignoreFailure)

Parameters

cmisDirectoryPath: Type: string
ignoreFailure: Type: bool

Parameters

cmisDirectoryPath : The path of the folder to delete. Smart parameters are supported.
ignoreFailure : Set to True to ignore any failure so the action will always return True.

Returns

If ignoreFailure is True, the action always returns True, even if the folder could not be deleted. If ignoreFailure is False, the action will return True if the directory is deleted, otherwise False is returned.

Level

All levels.

Details

The folder must be empty for the delete to be successful. Some, but not all, CMIS repositories have the notion of a "soft" delete where the deletion is performed at a later time. You should assume that once the object is deleted, that it is deleted forever. If an object is deleted, it can only be restored if the repository provides a mechanism to restore the object.

A delete failure can be ignored by using the ignoreFailure parameter. This allows actions to continue even if the delete should fail.

Example:

CMISDeleteFolder("/MyFolder/AnotherFolder", false)

This returns true if AnotherFolder is deleted, otherwise it returns false.

CMISDeleteFolder("/MyFolder/AnotherFolder", true)

This always returns true, even if the folder is not deleted.