Sets dtSearch Engine indexing and searching option settings.
File
File: dten600.idl
Module: COM Interface
Syntax
Group
Members
Properties
Property |
Description |
---|---|
Name of dtSearch alphabet file to use when parsing text into words. | |
Name of dtSearch alphabet file to use when parsing text into words. The alphabet file determines which characters are letters and what the rules are for handling capitalization and punctuation. If blank, dtSearch will use a default alphabet. The alphabet file only controls the indexing of characters in the range 32-127. Unicode character properties control the treatment of other characters. | |
BinaryFilesSettings value specifying the treatment of binary files. | |
Define characters considered to be text if binaryFiles is set ot dtsoFilterBinary | |
Use to replace the default connectors used in search requests. | |
Flags that control indexing of metadata. See the FieldFlags enum for values. | |
Name of the file containing a table of filename patterns for file formats that dtSearch cannot detect automatically, such as older versions of WordStar. The FileTypeTableFile is an XML file. To create the file, start dtSearch Desktop, click Options > Preferences > File Types and use the dialog box to set up the file type definitions. The XML file will be saved as filetype.xml in your dtSearch UserData folder. See File Types in the dtSearch Desktop help for information on this setting. | |
Character that enables fuzzy searching for a search term (default "%") | |
Directory where the dtSearch Engine and support files are located. This may be a shared, read-only network directory, and is usually the folder where dten600.dll is located. The dtSearch Engine automatically loads external file parser DLLs from the viewers subdirectory of the HomeDir directory. If no Home directory is supplied, the dtSearch Engine will attempt to determine the location of its home directory using Windows system calls. Often this will work, but it is better to supply a specific Home directory. | |
HyphenSettings value specifying the treatment of hyphens in text | |
If false, any word that begins with a digit will not be indexed. | |
Obsolete. This was used in older versions to enable LZW decompression in file parsers, which is now always enabled. | |
Character that indicates that a search term is a macro (default "@") | |
Wildcard character that matches a single digit | |
Maximum size of a single stored fields. Stored fields are field data collected during indexing that is returned in search results. | |
Words longer than the maxWordLength will be truncated when indexing. The default maxWordLength is 32. The maximum value is 128. | |
Maximum number of words that can be matched in a search. This can be any value from 16 to 256k. The default is 64k. If a search matches more unique words than the maxWordsToRetrieve limit, the error code dtsErMaxWords (137) will be returned. | |
List of noise words to skip during indexing (default: "noise.dat") A noise word is a word such as the or if that is so common that it is not useful in searches. To save time, noise words are not indexed and are ignored in index searches. When an index is created, dtSearch copies the list of words from noise.dat into the index directory and also builds the word list into other index files. After an index is created, subsequent changes to the noise word list will not affect indexing for that index | |
Character that enables phonic searching for a search term (default "#"). The regular expression mark ("##") is a doubling of the phonicChar. | |
A directory that the dtSearch Engine can use to store temporary files. Most applications should not set PrivateDir. PrivateDir, if non-blank, must be unique for each concurrent user of the dtSearch Engine. If the PrivateDir is blank, no directory will be reserved for temporary files, and dtSearch will use the Windows GetTempPath() call to get a directory for temporary files. | |
File segmentation rules, used to split up long text files into logical subdocuments during indexing. The SegmentationRulesFile is an XML file. To create the file, start dtSearch Desktop, click Options > Preferences > File Segmentation Rules and use the dialog box to set up the rules. The XML file will be saved as fileseg.xml in your dtSearch UserData folder. See File Segmentation Rules in the dtSearch Desktop help for information on this setting. | |
Character that enables stemming for a search term. The expression used for range searching (default "~~") a doubling of the stemmingChar. | |
Stemming rules for stemming searches (default: "stemming.dat") The stemming.dat file uses a plain text format and includes comments in the file that describe the file format. | |
Character that enables synonym searching for a search term (default "&") | |
Name of the file containing rules for extraction of field data from text files based on markers in the next The TextFieldsFile is an XML file. To create the file, start dtSearch Desktop, click Options > Preferences > Text Fields and use the dialog box to set up the text field definitions. The XML file will be saved as fields.xml in your dtSearch UserData folder. See Define Text Fields in the dtSearch Desktop help for information on this setting. | |
Flags specifying how text is processed during indexing. See TextFlags for values. | |
By default, the dtSearch Engine collects the first 80 characters of text from a file for the title associated with each document. Use this option to change the number of characters stored, up to a maximum of 512. | |
Specifies how each input file is divided into blocks before being filtered. | |
Flags controlling the behavior of the Unicode filtering algorithm. See UnicodeFilterFlags for values. | |
Minimum length of a run of text when applying the Unicode Filtering algorithm. This option specifies how many text characters must occur consecutively for a block of text to be included. At the default value, 6, a series of 5 text characters surrounded by non-text data would be filtered out. | |
Indicates Unicode ranges that are of interest when filtering. This is used to help the filtering algorithm to distinguish text from non-text data. It is only used as a hint in the algorithm, so if the text extraction algorithm detects text in another language with a sufficient level of confidence, it will return that text even if the language was not selected. | |
Amount of overlap when automatically breaking words when applying the Unicode Filtering algorithm. Unicode Filtering can automatically break long runs of letters into words each time more than Options.MaxWordLength consecutive letters are found. By default, a word break is inserted and the next word starts with the following character. Set UnicodeFilterWordOverlapAmount and also set the dtsoUfAutoWordBreakOverlapWords flag in UnicodeFilterFlags to start the next word before the end of the previous word. For example, suppose the maximum word length is set to 8, and the following run of letters is found: aaaaahiddenaaaaa. By default, this would be indexed as aaaaahid... more | |
Set to true to force all configuration files to be re-read. If the contents of a configuration file such as TextFieldsFile changes, but the filename is not changed, set UpdateFiles=true to indicate that dtSearch should discard any internally-cached copies of configuration files and re-read them from disk. | |
User-defined synonym sets. The UserThesaurusFile is an XML file. To create the file, start dtSearch Desktop, click Options > Preferences > User Thesaurus and use the dialog box to set up the synonym definitions. The XML file will be saved as thesaur.xml in your dtSearch UserData folder. See User Thesaurus in the dtSearch Desktop help for information on this setting. | |
Character used to indicate term weighting (example: apple:5) The prefix used to add field name in front of a word in an xfilter expression is a doubling of the weightChar (default "::"). For example, if you change the WeightChar to !, then an xfilter expression with a field would look like this: ... more | |
Comma-separated list of tags to ignore when indexing XML |
Methods
Method |
Description |
---|---|
Apply the changes |
Methods
Method |
Description |
---|---|
Apply the changes |
Properties
Property |
Description |
---|---|
Name of dtSearch alphabet file to use when parsing text into words. | |
Name of dtSearch alphabet file to use when parsing text into words. The alphabet file determines which characters are letters and what the rules are for handling capitalization and punctuation. If blank, dtSearch will use a default alphabet. The alphabet file only controls the indexing of characters in the range 32-127. Unicode character properties control the treatment of other characters. | |
BinaryFilesSettings value specifying the treatment of binary files. | |
Define characters considered to be text if binaryFiles is set ot dtsoFilterBinary | |
Use to replace the default connectors used in search requests. | |
Flags that control indexing of metadata. See the FieldFlags enum for values. | |
Name of the file containing a table of filename patterns for file formats that dtSearch cannot detect automatically, such as older versions of WordStar. The FileTypeTableFile is an XML file. To create the file, start dtSearch Desktop, click Options > Preferences > File Types and use the dialog box to set up the file type definitions. The XML file will be saved as filetype.xml in your dtSearch UserData folder. See File Types in the dtSearch Desktop help for information on this setting. | |
Character that enables fuzzy searching for a search term (default "%") | |
Directory where the dtSearch Engine and support files are located. This may be a shared, read-only network directory, and is usually the folder where dten600.dll is located. The dtSearch Engine automatically loads external file parser DLLs from the viewers subdirectory of the HomeDir directory. If no Home directory is supplied, the dtSearch Engine will attempt to determine the location of its home directory using Windows system calls. Often this will work, but it is better to supply a specific Home directory. | |
HyphenSettings value specifying the treatment of hyphens in text | |
If false, any word that begins with a digit will not be indexed. | |
Obsolete. This was used in older versions to enable LZW decompression in file parsers, which is now always enabled. | |
Character that indicates that a search term is a macro (default "@") | |
Wildcard character that matches a single digit | |
Maximum size of a single stored fields. Stored fields are field data collected during indexing that is returned in search results. | |
Words longer than the maxWordLength will be truncated when indexing. The default maxWordLength is 32. The maximum value is 128. | |
Maximum number of words that can be matched in a search. This can be any value from 16 to 256k. The default is 64k. If a search matches more unique words than the maxWordsToRetrieve limit, the error code dtsErMaxWords (137) will be returned. | |
List of noise words to skip during indexing (default: "noise.dat") A noise word is a word such as the or if that is so common that it is not useful in searches. To save time, noise words are not indexed and are ignored in index searches. When an index is created, dtSearch copies the list of words from noise.dat into the index directory and also builds the word list into other index files. After an index is created, subsequent changes to the noise word list will not affect indexing for that index | |
Character that enables phonic searching for a search term (default "#"). The regular expression mark ("##") is a doubling of the phonicChar. | |
A directory that the dtSearch Engine can use to store temporary files. Most applications should not set PrivateDir. PrivateDir, if non-blank, must be unique for each concurrent user of the dtSearch Engine. If the PrivateDir is blank, no directory will be reserved for temporary files, and dtSearch will use the Windows GetTempPath() call to get a directory for temporary files. | |
File segmentation rules, used to split up long text files into logical subdocuments during indexing. The SegmentationRulesFile is an XML file. To create the file, start dtSearch Desktop, click Options > Preferences > File Segmentation Rules and use the dialog box to set up the rules. The XML file will be saved as fileseg.xml in your dtSearch UserData folder. See File Segmentation Rules in the dtSearch Desktop help for information on this setting. | |
Character that enables stemming for a search term. The expression used for range searching (default "~~") a doubling of the stemmingChar. | |
Stemming rules for stemming searches (default: "stemming.dat") The stemming.dat file uses a plain text format and includes comments in the file that describe the file format. | |
Character that enables synonym searching for a search term (default "&") | |
Name of the file containing rules for extraction of field data from text files based on markers in the next The TextFieldsFile is an XML file. To create the file, start dtSearch Desktop, click Options > Preferences > Text Fields and use the dialog box to set up the text field definitions. The XML file will be saved as fields.xml in your dtSearch UserData folder. See Define Text Fields in the dtSearch Desktop help for information on this setting. | |
Flags specifying how text is processed during indexing. See TextFlags for values. | |
By default, the dtSearch Engine collects the first 80 characters of text from a file for the title associated with each document. Use this option to change the number of characters stored, up to a maximum of 512. | |
Specifies how each input file is divided into blocks before being filtered. | |
Flags controlling the behavior of the Unicode filtering algorithm. See UnicodeFilterFlags for values. | |
Minimum length of a run of text when applying the Unicode Filtering algorithm. This option specifies how many text characters must occur consecutively for a block of text to be included. At the default value, 6, a series of 5 text characters surrounded by non-text data would be filtered out. | |
Indicates Unicode ranges that are of interest when filtering. This is used to help the filtering algorithm to distinguish text from non-text data. It is only used as a hint in the algorithm, so if the text extraction algorithm detects text in another language with a sufficient level of confidence, it will return that text even if the language was not selected. | |
Amount of overlap when automatically breaking words when applying the Unicode Filtering algorithm. Unicode Filtering can automatically break long runs of letters into words each time more than Options.MaxWordLength consecutive letters are found. By default, a word break is inserted and the next word starts with the following character. Set UnicodeFilterWordOverlapAmount and also set the dtsoUfAutoWordBreakOverlapWords flag in UnicodeFilterFlags to start the next word before the end of the previous word. For example, suppose the maximum word length is set to 8, and the following run of letters is found: aaaaahiddenaaaaa. By default, this would be indexed as aaaaahid... more | |
Set to true to force all configuration files to be re-read. If the contents of a configuration file such as TextFieldsFile changes, but the filename is not changed, set UpdateFiles=true to indicate that dtSearch should discard any internally-cached copies of configuration files and re-read them from disk. | |
User-defined synonym sets. The UserThesaurusFile is an XML file. To create the file, start dtSearch Desktop, click Options > Preferences > User Thesaurus and use the dialog box to set up the synonym definitions. The XML file will be saved as thesaur.xml in your dtSearch UserData folder. See User Thesaurus in the dtSearch Desktop help for information on this setting. | |
Character used to indicate term weighting (example: apple:5) The prefix used to add field name in front of a word in an xfilter expression is a doubling of the weightChar (default "::"). For example, if you change the WeightChar to !, then an xfilter expression with a field would look like this: ... more | |
Comma-separated list of tags to ignore when indexing XML |
Remarks
To change option settings,
- Use the NewOptions method of the Server (IServer) object to create a new Options object.
- Change the values as needed, and
- Call Options.Save() to apply the changes
Option settings are not persisted anywhere so changes must be made each time a new program instance starts.
Option settings apply to the current thread and any threads created after the current thread. Therefore, each thread can have its own settings.
Class Hierarchy
IOptions