Options Class

Sets indexing and searching option settings.

Options Methods
Options Properties
Options Members

Syntax

Visual Basic

public class Options;

Methods

	Name	Description
	CheckConfiguration	Check that a dtSearch Engine application has been correctly deployed.
	Save	Apply changes to Options.

Properties

	Name	Description
	AlphabetFile	Name of dtSearch alphabet file to use when parsing text into words.
	BinaryFiles	Controls the treatment of binary files.
	BinaryFilterTextChars	Define characters considered to be text if Options.BinaryFiles is set ot dtsoFilterBinary
	BooleanConnectors	Use to replace the default connectors used in search requests.
	FieldFlags	Flags 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	Directory where the dtSearch Engine and support files are located.
	Hyphens	Controls the treatment of hyphens
	IndexNumbers	If false, any word that begins with a digit will not be indexed.
	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. Stored fields are field data collected during indexing that is returned in search results.
	MaxWordLength	Words longer than the maxWordLength will be truncated when indexing. The default maxWordLength is 32. The maximum value is 128.
	MaxWordsToRetrieve	Maximum number of words that can be matched in a search. This can be any value from 16 to 512k (32-bit)or 4,096k (64-bit). The default is 64k. If a search matches more unique words than the maxWordsToRetrieve limit, the error code dtsErMaxWords (137) will be returned.
	NoiseWordFile	List of noise words to skip during indexing (default: "noise.dat")
	OtherFlags	Other option flags
	PhonicChar	Character that enables phonic searching for a search term (default "#")
	PrivateDir	A per-user alternative location for options files and some temporary files. Most applications should not set PrivateDir.
	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 (default: "~").
	StemmingRulesFile	Stemming rules for stemming searches (default: "stemming.dat")
	StoredFieldDelimiterChar	Delimiter between multiple instances of a stored field in a single file (default: " ")
	SynonymChar	Character that enables synonym searching for a search term.
	TempFileDir	A directory that the dtSearch Engine can use to store temporary files.
	TextFieldsFile	Name of the file containing rules for extraction of field data from text files based on markers in the next
	TextFlags	Flags that control text-processing options
	TitleSize	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.
	UnicodeFilterBlockSize	Specifies how each input file is divided into blocks before being filtered.
	UnicodeFilterFlags	Flags 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 when Save() is called.
	UserThesaurusFile	User-defined synonym sets.
	WeightChar	Character used to indicate term weighting (example: apple:5)
	XmlIgnoreTags

Remarks

For more information about how these options affect indexing and searching, see Options Overview in dtSearchApiRef.chm.

When an Options object is first created, it is populated with the settings currently in effect. After you change one or more settings, call Save() to apply the changes. The new settings will apply to the currently-executing thread and to any newly-created threads. It will not affect other threads that are already running.

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.

Options cannot be changed within a callback function such as DataSource.GetNextDoc or IIndexStatusHandler.OnProgressUpdate. This is because dtSearch assumes that the options in effect for a thread at the start of a job will remain in effect until that job completes.

Example

dtSearch.Engine.Options opts = new dtSearch.Engine.Options(); opts.MaxStoredFieldSize = 998; opts.Save();

Class Hierarchy