The Folder plug-in deals with functionality required to retrieve information about folders and to manipulate them.
Function Summary
Function Details
CompareFolders
Binary content comparison of files within 2 folders.
Usable in combination with elements of type Checkpoint.
Input parameters |
||
Name |
Type |
Description & Examples |
FolderA |
formatted string |
The path to the first folder for the comparison.
Example: C:\Temp\Sample\ |
FolderB |
formatted string |
The path to the second folder for the comparison.
Example: C:\Temp\Sample2\ |
Include Subdirectories |
boolean string optional default value: true |
Options: •enabled: Recursive comparison of sub-directories is applied •disabled: Comparison is not executed on files within sub-directories |
CompareFolderWithHash
Compares the hash values of the files stored within a folder with a given table of hash | path values.
Usable in combination with elements of type Checkpoint.
Input parameters |
||
Name |
Type |
Description & Examples |
Folder |
formatted string |
The path to the folder for the comparison of file hashes.
Example: C:\Temp\Sample\ |
HashFile |
formatted string |
The path to the file that contains the hash values for comparison.
Example: C:\Temp\SampleHashValues.txt |
Hash Algorithm |
formatted string optional default value: SHA-1 |
List of available calculation algorithms to select from. Options: •MD5 •SHA-1 •SHA256 •SHA384 •SHA512 •RIPEMD160 |
Include Subdirectories |
boolean string optional default value: true |
Options: •enabled: Recursive comparison of sub-directories is applied •disabled: Comparison is not executed on files within sub-directories |
CopyFolder
Copies a folder. Returns Yes if copying was successful.
Usable in combination with elements of type Checkpoint.
Input parameters |
||
Name |
Type |
Description & Examples |
Source |
formatted string |
The path to the source folder.
Example: C:\Temp\Sample\ |
Target |
formatted string |
The target destination.
Example: C:\Windows\Sample2\ |
Include Subdirectories |
boolean string optional default value: true |
Options: •enabled: Recursive copy of sub-directories is executed •disabled: Copy is not executed sub-directories and files within sub-directories |
CreateFolder
Creates a folder. Returns Yes if the creation was successful.
Usable in combination with elements of type Checkpoint.
Input parameters |
||
Name |
Type |
Description & Examples |
Folder Name |
formatted string |
The path of the folder that has to be created.
Example: C:\Temp\Sample\NewFolder\ |
FolderExists
Checks if a folder exists. If the directory is not found, the returned result is No, otherwise Yes.
Usable in combination with elements of type Checkpoint.
Input parameters |
||
Name |
Type |
Description & Examples |
Folder |
formatted string |
The path of the folder whose existence has to be verified.
Example: C:\Temp\Sample\ExistingFolder\ |
FolderOpenDialog
Shows an open folder system dialog.
Usable in combination with elements of type Data Field.
This function does not accept parameters.
GetACL
Get a folder's access control list.
Usable in combination with elements of type Data Field.
Input parameters |
||
Name |
Type |
Description & Examples |
Folder |
formatted string |
The path of the folder whose ACL info has to be retrieved.
Example: C:\Temp\Sample\Folder\ |