Get Floder List

This object returns a list of folders with an option to recurse (look in subfolders).

Privileges

Normal

Input Parameters

Name Type Required Description
Folder Path String Yes This is the path in which the folder will be searched.

This field accepts a wildcard ('*').
Recurse Boolean Yes If selected, this will also search in subfolders and return a full list of all folders and subfolders.

Output Parameters

Name Type Description
Hosts Information Collection This is the list of folders. If there are one or more folders being found, this will be populated:

ItemTypeDescription
Folder Name StringThis is the folder name.
Full Path StringThis is the full folder path.
Last Access TimeDateTimeThis is the last time the folder was accessed as per the folder tag.
Last Write Time DateTimeThis is the last time the folder was written to.
Records Found Number The number of folders being returned, included in the array.
Result Number Returns a success value of zero or any value other than zero to indicate failure.
Result String String Object execution error details.

Example Input Parameters

Name Type Required Example
Folder Path String Yes C:\Temp*
Recurse Boolean Yes True (check box selected)