Delete Folders by Wildcard

Deletes the set of folders in the SA tree that match the specified search string, including the wildcard characters * and

?.

 

Input Arguments

 

0

String

Search String

The wildcard string of folders to remove. The characters * and ? are permitted.

1

Boolean

Case Sensitive Search

Indicates whether the search should be case-

sensistive in identifying matches.

2

Boolean

Allow Deleting all Folders

If set to FALSE, the command will fail if all folders match the search criteria.

 

Return Arguments

 

3

Integer

Num Deleted

The number of folders that were successfully deleted.

4

Integer

Num Failed

The number of folders that matched the search

criteria but could not be deleted.

 

Returned Status

 

SUCCESS

The matching folders were successfully deleted.

FAILURE

Argument 2 was FALSE and all folders matched the search criteria.

 

Remarks

Enter wildcard values for the folder name using the same conventions as elsewhere in SA. Asterisks (*) are wildcards for one or more characters, while question marks (?) are placeholders for single characters. Specific characters can also be found using brackets[]. To delete all folders that start with s1 followed by two characters, the search criteria would be s1??.