Vicon Shogun banner

Description

Gets a list of the folders found in a named folder.

You can optionally return only the subset which match a naming pattern using the -pattern flag. You can also search sub-folders of the directories using the -recursive flag.

Be sure to use forward slashes instead of back-slashes.

Functional area

System

Command syntax

Syntax

getDirList "searchDirectory"[-recursive] [-nameOnly] [-pattern string]

Arguments

NameTypeRequiredComments
searchDirectorystringyesThe folder for which to search for folders. Be sure to use forward slashes.

Flags

NameFlag argumentsArgument typeExclusive toComments
recursive0Searches for all folders and sub-folders under the specified folder. By default sub-folders are not searched.
nameOnly0Lists only the names of the folders rather than their full paths (e.g. "Data" for a path of "C:/MyFiles/Data/"
pattern1stringSearches for folders which match a specific search criteria. By default all folders are returned. The pattern must use wildcard syntax (e.g. "Data*")

Return value

string array

Returns a string array with all of the folders found.

Examples

// Get a list of all of the folders found under my capture session.
// Also get the sub-folders.
string $dirList[] = `getDirList "C:/Data/MyProject001/" -recursive`;
print $dirList;

Additional information

Related commands