TCustomShellTreeView.GetFilesInDir procedure

Declaration

class procedure GetFilesInDir(const ABaseDir: string; AMask: string; 
 AObjectTypes: TObjectTypes; 
 AResult: TStrings; 
 AFileSortType: TFileSortType=fstNone; 
 ACaseSensitivity: TMaskCaseSensitivity=mcsPlatformDefault)

Arguments

Description

GetFilesInDir is a class method which can be called without an existing instance of a TCustomShellTreeView descendant. For example:

TShellTreeView.GetFilesInDir('/path/to/dir', '*.pas;*.pp', 
  [otNonFolders], AStringList, [fstAlphabet], mcsCaseSensitive);

It performs actions to gather directories and/or files as in the PopulateTreeNodeWithFiles method, but does not store the file system objects to the Items property.

GetFilesInDir calls an implementation routine to access the local file system and to store matching file system objects in AResult. It calls FindFirstUTF8 / FindNextUTF8 / FindCloseUTF8 (in LazUtils) to gather TSearchRec information for the folders or files which match the specified criteria. The file system information is transferred to TFileItem instances which are stored in the Objects property in AResult. The Names property in AResult contains the names for the directories or files.

Use ABaseDir to specify the folder examined in the method, and the base directory used to resolve any relative path references in AMask. A trailing path delimiter is not required in ABaseDir; it is appended (when needed) in the implementation.

Use AMask to specify one or masks for file system items considered a match in the method. Use the ';' character to delimit mask values in the argument. When omitted (or set to an empty string), the AllFilesMask ('*') is used when checking file system objects.

Use AObjectTypes to specify the file system objects examined in the method. See TObjectType for the values allowed in the set type, and their meanings.

AResult is a TStrings instance where folders and/or files matching the specified criteria are stored and returned to the caller. Use the Names property in AResult to access the names for the file system objects in the list. Use the Objects property in AResult to access TFileItem instances with the path and search record information for the file system objects. A value in Object must be cast to a TFileItem type to access the properties specific to the object instance. Use the Clear method in AResult to free the Names and Objects in the TStrings instance.

Use AFileSortType to specify the sort order applied to the values stored in AResult. See TFileSortType for the values allowed in the argument, and their meanings.

Use ACaseSensitivity to specify whether case sensitivity is used when comparing values in AMask to select matching file system objects. See TMaskCaseSensitivity for the values allowed in the argument, and their meanings. The default value for the argument is mcsPlatformDefault in the implementation routine.

Modified in LCL version 3.0 to have public visibility.

See also

• Items
• PopulateTreeNodeWithFiles
• TFileItem
• TFileSortType
• TMaskCaseSensitivity
• TObjectType
• TObjectTypes
• FindFirstUTF8
• FindNextUTF8
• FindCloseUTF8
• TMaskList
• TSearchRec