Remove Folder Action

Declaration

<AMREMOVEFOLDER FOLDER="text" TORECYCLE="yes/no" RESULTDATASET="text" />

See Also

Remove Folder Action-Setting Properties, Copy File, Rename File, Delete File, Change Folder, Create Folder

Description

Removes a folder or tree of folders. If the folder specified contains sub-folder, they will also be removed.

Practical Usage

See description.

Parameters

General Tab

Folder

Text, Required
MARKUP:
a) FOLDER="c:\foldernametodelete\"
b) FOLDER="c:\foldernametodelete\subfoldername"

Specifies the folder or folders to delete.

Place in Recycle Bin

Yes/No, Optional, Default: NO
MARKUP: TORECYCLE="YES"

Specifies whether to permanently delete the folders or send them to the Recycle bin.

Create and Populate Dataset with Result Information

Text, Optional
MARKUP: RESULTDATASET="DatasetName"

Specifies the name of a dataset to be created and populated with the result. In addition to the standard dataset fields, the dataset will contain the following:

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<AMREMOVEFOLDER FOLDER="C:\FolderToDelete\SubfolderToDelete" TORECYCLE="YES" RESULTDATASET="RemoveFolderDS" />