Sign in Join
FPDoc Onlineexperiment

FindAllDirectories function

In unit FileUtil

Stores directory names matching the search criteria in a TStringList class instance.

Declaration

pascal
function FindAllDirectories(const SearchPath: string; 
                           SearchSubDirs: Boolean=True; 
                           PathSeparator: char=';') : TStringList
                           ;  overload

Arguments

SearchPath

Path(s) to the directories examined in the routine.

SearchSubDirsTrue to recurse into subdirectories in the search.
PathSeparator

Delimiter used between path names in the SearchPath parameter.

Function result

Stores directory names matching the search criteria.

Description

FindAllDirectories is an overloaded routine used to store directory path names that match the specified search criteria in a TStringList class instance. The procedure variant uses an existing TStringList class instance to store the matching directory names. The function variant allocates a TStringList class instance used to capture the matching directory names.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.