File Search
Returns a list of files that satisfy the given filter.
Privileges
Normal
Input Parameters
Name | Type | Required | Description |
---|---|---|---|
Folder | String | Yes | The path to search for files that satisfy the filter. |
Filter | String | No | The filter to be applied to the file names. i.e. *.txt |
Recurse | Boolean | No | Select to search in all folders from subdirectories contained in the path. |
Output Parameters
Name | Type | Description |
---|---|---|
Files | Collection | List of files located in Folder location. If Recurse option is set then files from subdirectories are also listed. |
Result | Number | Returns a success value of zero or any value other than zero to indicate failure. |
Example Input Parameters
Name | Type | Required | Example |
---|---|---|---|
Folder | String | Yes | C:\folder1\folder2 |
Filter | String | No | *.txt or Name*.txt |
Recursive | Boolean | No | Indicates to search in folders contained in the path. |