Links
dtSearch Text Retrieval Engine Programmer's Reference 7.70
IOptions Interface
dten600.idl | Interfaces | Legend | Members | Methods | Properties | Send Feedback

Sets dtSearch Engine indexing and searching option settings.

Class Hierarchy
[ object, uuid(697DF02A-B24E-11D3-B57C-00105AA461D0), dual, helpstring("IOptions Interface"), pointer_default(unique) ]
interface IOptions : IDispatch;
File
Remarks

To change option settings,

  1. Use the NewOptions method of the Server (IServer) object to create a new Options object.
  2. Change the values as needed, and
  3. 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.

Group
Methods
Method 
Description 
Save 
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. 
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. 
Name of the file containing a table of filename patterns for file formats that dtSearch cannot detect automatically, such as older versions of WordStar. 
Character that enables fuzzy searching for a search term (default "%") 
Directory where the dtSearch Engine and support files are located. 
HyphenSettings value specifying the treatment of hyphens in text 
If false, any word that begins with a digit will not be indexed. 
Obsolete. 
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. 
Words longer than the maxWordLength will be truncated when indexing. 
Maximum number of words that can be matched in a search. 
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. 
Character that enables phonic searching for a search term (default "#"). 
A directory that the dtSearch Engine can use to store temporary files. 
File segmentation rules, used to split up long text files into logical subdocuments during indexing. 
Character that enables stemming for a search term. 
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. 
Flags specifying how text is processed during indexing. 
By default, the dtSearch Engine collects the first 80 characters of text from a file for the title associated with each document. 
Specifies how each input file is divided into blocks before being filtered. 
Flags controlling the behavior of the Unicode filtering algorithm. 
Minimum length of a run of text when applying the Unicode Filtering algorithm. 
Indicates Unicode ranges that are of interest when filtering. 
Amount of overlap when automatically breaking words when applying the Unicode Filtering algorithm. 
Set to true to force all configuration files to be re-read. 
User-defined synonym sets. 
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 "::"). 
Comma-separated list of tags to ignore when indexing XML 
Legend
 
Property 
 
Method 
Links
You are here: COM Interface > Interfaces > IOptions Interface
Copyright (c) 1995-2012 dtSearch Corp. All rights reserved.