NDEVR
API Documentation
FileSearch

Logic for searching for files based on some criteria. More...

Collaboration diagram for FileSearch:
[legend]

Public Member Functions

Buffer< FileperformSearch () const
 Performs the file search and returns all matching files.

Public Attributes

Buffer< Fileexcluded_list
 Files or directories to exclude from results.
Buffer< Filefiles_recursively_to_search
 Root files or directories to search within.
uint04 max_recursion_level = Constant<uint04>::Max
 Maximum directory depth for recursive searches.
Buffer< Stringsearch_extensions
 File extensions to match during the search.

Protected Member Functions

void performSearch (const File &current_file, Buffer< File > &files, uint04 recursion_level) const
 Recursively searches a directory for matching files.

Detailed Description

Logic for searching for files based on some criteria.


File searches help locate files or directories within other directories.

Definition at line 640 of file File.h.

Member Function Documentation

◆ performSearch() [1/2]

Buffer< File > FileSearch::performSearch ( ) const

Performs the file search and returns all matching files.

Returns
A Buffer containing the files that match the search criteria.

◆ performSearch() [2/2]

void FileSearch::performSearch ( const File & current_file,
Buffer< File > & files,
uint04 recursion_level ) const
protected

Recursively searches a directory for matching files.

Parameters
[in]current_fileThe current file or directory being searched.
[in]filesThe buffer to accumulate matching results into.
[in]recursion_levelThe current recursion depth.

The documentation for this class was generated from the following file: