CleanFolderContents

CleanFolderContents

SYNOPSIS

Cleans contents of the specified folder.

SYNTAX

  - ActionType: CleanFolderContents
    ActionDescription: 
    FolderName: 
    ExactVariableCheck: 

EXAMPLES

EXAMPLE 1

  - ActionType: CleanFolderContents
    ActionDescription: Cleans all files and folders in the specified directory
    FolderName: D:\somefolder1
    ExactVariableCheck: false

EXAMPLE 2

  - ActionType: CleanFolderContents
    FolderName: D:\somefolder2

PARAMETERS

ActionType

This parameter specifies action name. CleanFolderContents value is required for this action to be executed.

Required: true
Default Value: CleanFolderContents
Accepted Value: CleanFolderContents
Accepted Value Type: string
Accepts Variables: false

ActionDescription

This parameter specifies description of the action.

Required: false
Default Value: none
Accepted Value: any
Accepted Value Type: string
Accepts Variables: false

FolderName

This parameter specifies absolute path to folder which should be cleaned.

Required: true
Default Value: none
Accepted Value: any
Accepted Value Type: string
Accepts Variables: true

ExactVariableCheck

This parameter specifies how to check YAML file variables specified in other parameters. If value is:

• true - variable value will be set when it is a separated word. Example: $var1$var2 will not be considered as $var1 and $var2.
• false - variable value will be set even if it is not separated word . Example: $var1$var2 will be considered as $var1 and $var2.

Required: false
Default Value: none
Accepted Value: true\false
Accepted Value Type: boolean
Accepts Variables: false

NOTES