removeSubtree

Verfügbar für: Content Management Server

Aufgabe: Die Prozedur löscht den angegebenen Ordner und alle darin enthaltenen Dateien.

Syntax:

removeSubtree [-verbose {0|1}] [-check {0|1}] [-removeExternalMirrors {0|1}] [-force {0|1}] objectIdOrPath

Funktionsparameter:

  • -verbose legt fest, ob Fortschrittsinformationen ausgegeben werden sollen (1, Voreinstellung) oder nicht (0). Wenn der Befehl im Tcl-Client aufgerufen wird und -verbose den Wert 0 hat, wird der Befehl im Server ausgeführt.

  • -check legt fest, ob Zugriffsrechte und Links geprüft werden sollen (1, Voreinstellung) oder nicht (0). Die Voreinstellung bewirkt, dass vor der Ausführung des Befehls alle Dateien daraufhin geprüft werden, ob sie gelöscht werden können, d. h. keine Linkziele sind und die Benutzerrechte ausreichend sind. Nur wenn diese Bedingungen erfüllt sind, wird die Ausführung des Kommandos fortgesetzt. Der Wert 0 dagegen führt diese Prüfung nicht durch, wodurch die Teilhierarchie gegebenenfalls unvollständig gelöscht wird.

  • -removeExternalMirrors (ab Version 6.5.0 PP1) bewirkt, dass Spiegeldateien außerhalb des zu löschenden Teilbaums, deren jeweiliges Original jedoch im Teilbaum liegt, ebenfalls gelöscht werden.

  • -force erzwingt, dass das Kommando weiter ausgeführt wird (1), auch wenn beim Löschen von Dateien Fehler auftreten. Fehler können dann auftreten, wenn zu löschende Dateien Linkziele sind oder aufgrund fehlender Zugriffsrechte nicht gelöscht werden können. Die Voreinstellung (0) bewirkt, dass das Kommando bei Fehlern abgebrochen wird.

  • objIdOrPath ist die ID des Ordners oder ihr Pfad. Der Pfad muss absolut sein, d. h. mit einem Schrägstrich beginnen.

Rückgabewert bei Erfolg: keiner.

Erforderliche Rechte: Der Benutzer muss das Recht permissionRoot für den Ordner und alle darin enthaltenen Dateien haben, andernfalls können die betreffenden Dateien nicht gelöscht werden.

Beispiel:

CM>removeSubtree -verbose 1 -check 0 -force 1 /internet