Verfügbar für: Content Management Server
Task: The procedure deletes the specified folder and all the files it contains.
Syntax:
removeSubtree [-verbose {0|1}] [-check {0|1}] [-removeExternalMirrors {0|1}] [-force {0|1}] objectIdOrPath
Function parameters:
-verbose
determines whether progress
information is to be output (1
, default) or not
(0
). If this command is issued via the Tcl client and
verbose
is 0
, the command is
executed in the server.
-check
determines whether access
permissions and links are to be checked (1
, default) or
not (0
). The default has the effect that prior to command
execution all files are checked for links pointing to them and for
sufficient user permissions. Command execution continues only if these
conditions are met. If 0
has been specified, this check is
not performed, meaning that the subhierarchy might not be completely
deleted.
-removeExternalMirrors
(from version 6.5.0 PP1)
causes mirror files outside the subtree (originating from files inside the
subtree) to be deleted as well.
-force
forces the command execution to
continue (1
) even if deleting files causes errors. Errors
can occur if files to be deleted are link targets or if the required
permission is missing. The default (0
) causes the command
to terminate on errors.
objIdOrPath
is the ID of the folder or its
path. The path must be absolute, i.e. start with a slash.
Return value if successful: none
Necessary permissions: The user must have the
permissionRoot
permission for the folder and all of its
files. Otherwise the files concerned cannot be deleted.
Example:
CM>removeSubtree -verbose 1 -check 0 -force 1 /internet