| dtSearch Text Retrieval Engine .NET interface |
|
dtSearch.Engine Namespace
dtSearch Text Retrieval Engine developer API for .NET.
To use this API, create a reference in your project to dtSearchNetAPI.dll.
dtSearchNetApi.dll provides a .NET wrapper around the dtSearch Engine DLL that actually implements indexing and searching, dten600.dll. Therefore,
dten600.dll must either be on the system PATH, or it must be in the same folder where dtSearchNetApi.dll is located.
Source code to dtSearchNetAPI.dll is included with the dtSearch Engine as a Visual C++ project file, here: C:\Program Files\dtSearch Developer\examples\cpp\dtSearchNetApi.
Namespace hierarchy
Classes
| Class |
Description |
|
DataSource
|
Interface for the dataSourceToIndex member of IndexJob, for indexing non-file data sources such as databases. |
|
FileConverter
|
Converts files to HTML, RTF, or text, optionally marking hits with caller-supplied tags. |
|
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. |
|
NetJobBase
|
|
|
Options
|
Sets indexing and searching option settings. |
|
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. |
|
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
|
Builds a scrolling list of indexed words a program can update as a user types in a search request. |
Interfaces
Delegates
Enumerations
| Enumeration |
Description |
|
AbortValue
|
Values that CheckForAbort (IIndexStatusHandler or ISearchStatusHandler) can return to indicate whether a job should continue. |
|
BinaryFilesSettings
|
Values for Options.BinaryFiles |
|
ConvertFlags
|
Flags for FileConverter.Flags |
|
ConvertPathFlags
|
Flags for Server.ConvertPath |
|
DebugLogFlags
|
Flags for Server.SetDebugLogging |
|
ErrorCodes
|
Error codes returned in a JobErrorInfo through the Errors property of SearchJob, IndexJob, etc. |
|
FieldFlags
|
Flags for Options.FieldFlags |
|
HyphenSettings
|
Values for Options.Hyphens |
|
IndexingFlags
|
Values for IndexJob.Flags |
|
IndexingStep
|
Values for IndexJob.StatusIndexingStep |
|
MessageCode
|
Values for IndexProgressInfo.UpdateType, which indicates the reason for a callback sent through IIndexStatusHandler |
|
OutputFormats
|
Output file formats for conversion of documents and generation of search reports |
|
ReportFlags
|
Flags for SearchReportJob.Flags |
|
SearchFlags
|
Values for SearchJob.SearchFlags and WordListBuilder.ListMatchingWords |
|
SortFlags
|
Values for SearchResults.Sort |
|
TextFlags
|
Values for Options.TextFlags |
|
TypeId
|
Values for IndexFileInfo.TypeId and SearchResultsItem.TypeId |
|
UnicodeFilterFlags
|
Values for Options.UnicodeFilterFlags |