dtSearch::Engine Namespace

This API implements a .NET wrapper around the dtSearch Text Retrieval Engine. For overview topics covering indexing, searching, the dtSearch query language, etc., see the dtSearchApiRef.chm file included with the dtSearch Engine.

Remarks

To use this API, create a reference in your project to one of these files:

dtSearchNetApi4.dll (.NET 4.0 and later)

dtSearchNetApi3.dll (.NET 3.5 and later)

dtSearchNetApi2.dll (.NET 2.0 and later)

dtSearchNetApi.dll (.NET 1.1 only)

Source code to dtSearchNetAPI*.dll components is included with the dtSearch Engine as Visual C++ project files, here:

C:\Program Files\dtSearch Developer\examples\cpp\dtSearchNetApi4

C:\Program Files\dtSearch Developer\examples\cpp\dtSearchNetApi3

C:\Program Files\dtSearch Developer\examples\cpp\dtSearchNetApi2

C:\Program Files\dtSearch Developer\examples\cpp\dtSearchNetApi

Deployment

For information on deployment of the dtSearch .NET API, please see "Installing the dtSearch Engine with your Application" in the Overviews section.

IDisposable

When using the dtSearch Engine API, it is essential to use the IDisposable pattern with all API objects except JobErrorInfo. Otherwise, the .NET garbage collector may take a long time to free memory used by potentially large objects such as SearchResults, resulting in memory depletion in long-running applications. In C# code, use a "using" clause with dtSearch Engine API objects, and in other code call Dispose() when you are done with an object.

Samples

For sample applications, see these folders under C:\Program Files\dtSearch Developer\examples:

C# (.NET 1.1)	cs
C# (.NET 2.0 and later)	cs2
C# (.NET 4.0 and later)	cs4
VB.NET (.NET 1.1)	vb.net
VB.NET (.NET 2.0 and later)	vb.net2
VB.NET (.NET 4.0 and later)	vb.net4

Classes

DataSource	Interface for the dataSourceToIndex member of IndexJob, for indexing non-file data sources such as databases.
DisposableObject	Internal Base class for dtSearch.Engine objects that implement IDisposable.
ExtractionOptions	ExtractionOptions (attached to a FileConvertJob) specifies how embedded images and attachments should be handled.
FileConverter	Converts files to HTML, RTF, or text, optionally marking hits with caller-supplied tags.
IndexCache	An index cache keeps a pool of indexes open for faster searching
IndexFileInfo	Information about a document being indexed (part of IndexProgressInfo)
IndexInfo	Information about the current state of an index
IndexJob	Create or update indexes
IndexProgressInfo	State of an index update
JobErrorInfo	Records error messages after an IndexJob, SearchJob, FileConverter, etc.
ListIndexJob	List words, fields, or filenames in an index to a file or to a memory buffer
NetJobBase	Base class for SearchJob, IndexJob, FileConverter, etc.
Options	Sets indexing and searching option settings.
SearchFileInfo	Information about a document being searched in an unindexed search (part of SearchProgressInfo)
SearchFilter	Filters a search to allow only selected documents from an index to be returned.
SearchJob	Use to search indexes or to search without an index.
SearchProgressInfo	State of an index update
SearchReportJob	Generates a report showing each hit in one or more documents, with a specified amount of context
SearchResults	List of documents retrieved in a search.
SearchResultsItem	Information about a document retrieved in a search.
Server	dtSearch Engine version information, diagnostic logging, and utility functions.
WordListBuilder	WordListBuilder provides a way to list words, field names, or field values in an index

Enumerations

AbortValue	Values that CheckForAbort (IIndexStatusHandler or ISearchStatusHandler) can return to indicate whether a job should continue.
BinaryFilesSettings	Values for dtsOptions.binaryFiles (C++), Options.BinaryFiles (.NET), and Options.setBinaryFiles (Java). See Filtering Options.
ConvertFlags	Flags for dtsConvertJob2 (C++) and FileConverter (.NET, Java)
ConvertPathFlags	Flags for Server.ConvertPath
DebugLogFlags	Flags for Server.SetDebugLogging
ErrorCodes	Error codes are returned after a job completes. In the C++ API, use the dtsErrorInfo attached to a job to access error codes. In .NET, use the Errors property of the job. In Java, use getErrors().
ExtractionOptionsFlags	Flags to control the extraction of attachments and images using FileConverter (.NET, Java) or dtsFileConvertJob2 (C++)
FieldFlags	Control indexing of meta-data associated with documents
FileInfoFlags	Values for dtsFileInfo and dtsIndexProgressInfo.fileFlags (C++) and IndexFileInfo (.NET, Java)
HyphenSettings	Values for Options.Hyphens, specifying how hyphens should be indexed.
IndexingFlags	Values for indexing flags in dtsIndexJob
IndexingStep	Describes the current status of the indexer
ListIndexFlags	Flags used in dtsListIndexJob (C++) and ListIndexJob (.NET, Java)
MessageCode	MessageCodes are sent to callback functions during an index or search to update the caller on the status of the job.
OutputFormats	Output file formats for conversion of documents and generation of search reports
ReportFlags	Flags for dtsSearchReportJob (C++) and SearchReportJob (Java, .NET)
SearchFlags	Flags to control searches
SortFlags	Flags to control the sorting of search results.
TextFlags	Values for Options.TextFlags (.NET), Options.setTextFlags() (Java), and dtsOptions.textFlags (C++)
TypeId	File type identifiers
UnicodeFilterFlags	Values for Options.UnicodeFilterFlags (.NET) or dtsOptions.unicodeFilterFlags (C++) or Options.setUnicodeFilterFlags(java).
UnindexedSearchFlags	Values for dtsSearchJob.unindexedSearchFlags
WordListBuilderFlags	Values for WordListBuilder.SetFlags

Interfaces

IIndexStatusHandler	Provides a way for the caller to receive updates as the IndexJob progresses.
ISearchStatusHandler	Interface for SearchJob.StatusHandler.
ISearchStatusHandler2	Interface for SearchJob.StatusHandler, with additional OnProgressUpdate callback.