dtsOptions Structure

Sets dtSearch Engine indexing and searching option settings.

struct dtsOptions {
  long binaryFiles;
  char binaryFilterTextChars[256];
  long hyphens;
  char alphabetFile[FileNameLen];
  long indexNumbers;
  char noiseWordFile[FileNameLen];
  char stemmingRulesFile[FileNameLen];
  long maxWordsToRetrieve;
  long maxStoredFieldSize;
  long titleSize;
  char xmlIgnoreTags[512];
  long maxWordLength;
  char segmentationRulesFile[FileNameLen];
  char textFieldsFile[FileNameLen];
  char userThesaurusFile[FileNameLen];
  long updateFiles;
  long lzwEnableCode;
  char homeDir[FileNameLen];
  char privateDir[FileNameLen];
  char booleanConnectors[512];
  char fileTypeTableFile[FileNameLen];
  long textFlags;
  long maxFieldNesting;
  long autoFilterSizeMB;
  char macroChar;
  char fuzzyChar;
  char phonicChar;
  char stemmingChar;
  char synonymChar;
  char weightChar;
  char matchDigitChar;
  char storedFieldDelimiterChar;
  long fieldFlags;
  char unicodeFilterRanges[256];
  long unicodeFilterBlockSize;
  long unicodeFilterFlags;
  long unicodeFilterMinTextSize;
  dtsLanguageAnalyzerInterface * pAnalyzer;
  long unicodeFilterWordOverlapAmount;
};

File

dtsearch.h

Remarks

To change option settings,

Call dtssGetOptions to get the option settings currently in effect
Change the values in dtsOptions as needed, and
Call dtssSetOptions 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.

Data Members

Data Member	Description
alphabetFile	Name of dtSearch alphabet file to use when parsing text into words.
autoFilterSizeMB	Size of files that are always processed using the unicode filtering algorithm, in megabytes.
binaryFiles	BinaryFilesSettings value specifying the treatment of binary files.
binaryFilterTextChars	Define characters considered to be text if binaryFiles is set ot dtsoFilterBinary
booleanConnectors	Use to replace the default connectors used in search requests.
fieldFlags	FieldFlags values that control indexing of metadata.
fileTypeTableFile	Name of the file containing a table of filename patterns for file formats that dtSearch cannot detect automatically, such as older versions of WordStar.
fuzzyChar	Character that enables fuzzy searching for a search term (default "%")
homeDir	"Home" directory where the dtSearch Engine and support files are located.
hyphens	HyphenSettings value specifying the treatment of hyphens in text
indexNumbers	If false, any word that begins with a digit will not be indexed.
lzwEnableCode	Obsolete.
macroChar	Character that indicates that a search term is a macro (default "@")
matchDigitChar	Wildcard character that matches a single digit (default "=")
maxFieldNesting	Maximum depth of nested fields (value must be between 1 and 32)
maxStoredFieldSize	Maximum size of a single stored field.
maxWordLength	Words longer than the maxWordLength will be truncated when indexing.
maxWordsToRetrieve	Maximum number of words that can be matched in a search.
noiseWordFile	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.
pAnalyzer	Pointer to language analyzer to use for word breaking
phonicChar	Character that enables phonic searching for a search term (default "#").
privateDir	A directory that the dtSearch Engine can use to store temporary files.
segmentationRulesFile	File segmentation rules, used to split up long text files into logical subdocuments during indexing.
stemmingChar	Character that enables stemming for a search term.
stemmingRulesFile	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.
storedFieldDelimiterChar	Character to insert between multiple instances of a stored field in a single document
synonymChar	Character that enables synonym searching for a search term (default "&")
textFieldsFile	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.
textFlags	Flags that control text-processing options.
titleSize	Use this option to change the number of characters stored as the "title" property of each document, up to a maximum of 512.
unicodeFilterBlockSize	Specifies how each input file is divided into blocks before being filtered.
unicodeFilterFlags	UnicodeFilterFlags values controlling the behavior of the Unicode filtering algorithm.
unicodeFilterMinTextSize	Minimum length of a run of text when applying the Unicode Filtering algorithm.
unicodeFilterRanges	Indicates Unicode ranges that are of interest when filtering.
unicodeFilterWordOverlapAmount	Amount of overlap when automatically breaking words when applying the Unicode Filtering algorithm.
updateFiles	Set to true to force all configuration files to be re-read.
userThesaurusFile	User-defined synonym sets.
weightChar	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 "::").
xmlIgnoreTags	Comma-separated list of tags to ignore when indexing XML

Group

Classes

Methods

Method	Description
copy	Copy another dtsOptions
equals	Compare options for equality
validate	Force all data in dtsOptions to valid values.

Legend

	Data Member
	Method

Links

Data Members, Classes, Legend, Members, Methods