You are here: C++ API > Classes > dtsFileSpec Structure
Close
dtSearch Text Retrieval Engine Programmer's Reference
ContentsIndexHome
PreviousUpNext
dtsFileSpec Structure
Collapse AllCollapse AllExpand AllExpand All

Used to define a set of files to search or index

File: dtsearch.h

Syntax
C++
struct dtsFileSpec { const char * includeFilters; const char * excludeFilters; char dir[FileNameLen]; char dirListName[FileNameLen]; char fileListName[FileNameLen]; const char * dirList; };
Name
Description
dtsFileSpec
Constructor
Name
Description
dir
Directory to scan using the filters. Deprecated: Use dirList.
dirList
Null-delimited string set containing list of directories to scan using the filters
dirListName
Name of file containing list of directories to scan using the filters
excludeFilters
Filename filters used to exclude files in selected directories. Must point to a null-delimited string set, terminated by a double-null. If not used, initialize to 0.
Filename filters containing a slash (/ or \) are matched against the full path and filename. Filename filters without a slash (/ or \) are matched against only the filename.
fileListName
Name of file containing list of files.
includeFilters
Filename filters to apply to files in the directories selected. Must point to a null-delimited string set, terminated by a double-null. If not used, initialize to 0.
Filename filters containing a slash (/ or \) are matched against the full path and filename. Filename filters without a slash (/ or \) are matched against only the filename.
Data Members
Name
Description
dir
Directory to scan using the filters. Deprecated: Use dirList.
dirList
Null-delimited string set containing list of directories to scan using the filters
dirListName
Name of file containing list of directories to scan using the filters
excludeFilters
Filename filters used to exclude files in selected directories. Must point to a null-delimited string set, terminated by a double-null. If not used, initialize to 0.
Filename filters containing a slash (/ or \) are matched against the full path and filename. Filename filters without a slash (/ or \) are matched against only the filename.
fileListName
Name of file containing list of files.
includeFilters
Filename filters to apply to files in the directories selected. Must point to a null-delimited string set, terminated by a double-null. If not used, initialize to 0.
Filename filters containing a slash (/ or \) are matched against the full path and filename. Filename filters without a slash (/ or \) are matched against only the filename.
Methods
Name
Description
clear
Clear all data
copy
Copy data from another dtsFileSpec (shallow copy)
Constructors
Name
Description
dtsFileSpec
Constructor
Name
Description
clear
Clear all data
copy
Copy data from another dtsFileSpec (shallow copy)

fileListName provides a way to simply pass a list of files to search or index. 

Alternatively, the calling program can ask dtSearch to list the files in one directory (the dir member) or in a list of directories (the dirListName member), using the supplied include and exclude filters. 

To specify a directory and all subdirectories, add a <+> symbol at the end, like this: C:DOCS<+>