C++ API

Topic	Description
Using the dtSearch Engine with C++	How to add the dtSearch Engine to a C++ project
Enumerations
Classes	The following table lists classes in this documentation.
Functions	The following table lists functions in this documentation.
Structs, Records, Enums	The following table lists structs, records, enums in this documentation.
Types	The following table lists types in this documentation.
Variables	The following table lists variables in this documentation.
Language Analyzer API	Integrate an external language analyzer with the dtSearch Engine, to implement morphological analysis or word breaking.
External Thesaurus API	Implements synonym expansion in an external DLL.
File Parser API	Use to add support for custom file formats to the dtSearch Engine

Legend

	Structure
	Method

Classes

Class	Description
dtsDataSource	Used by dtsIndexJob to index non-file data that is passed to the indexer through callbacks.
dtsErrorInfo	Used with dtsIndexJob and dtsSearchJob to record errors that occur during indexing or searching.
dtsFileConvertJob2	Converts files to HTML, RTF, or text, optionally marking hits with caller-supplied tags.
dtsFileDate	Contains a file modification or creation time. File dates are always reported as UTC time.
dtsFileSpec	Used to define a set of files to search or index
dtsIndexCache	An index cache keeps a pool of indexes open for faster searching
dtsIndexCacheOptions	Options to control the behavior of an index cache (dtsIndexCache)
dtsIndexCacheStatus	Status of an index cache (dtsIndexCache), obtained from dtsIndexCache.getStatus().
dtsIndexJob	Describes an indexing task to be performed.
dtsInputStream	Abstract interface to any source of document data.
dtsInputStreamReader	Provides a layer of abstraction around a dtsInputStream.
dtsIndexMergeJob	Passed to dtssMergeIndexes to merge two more indexes together.
dtsIndexVerifyJob	dtsIndexVerifyJob is passed to dtssVerifyIndex, and is used to verify that an index is in good condition.
dtsListIndexJob	List the contents of an index
dtsMakeViewerParams	Information passed to the makeViewer2 callback function in dtsViewerInfo
dtsMergeStatusInfo	Status of a merge job in progress
dtsOptions	Sets dtSearch Engine indexing and searching option settings.
dtsOutputInfo	Describes how you want a dtSearch search report to be generated.
dtsRecognitionSignature	Provides information about how to recognize a particular file type.
dtsSearchFilter	Used to efficiently limit the results of a search to a specified subset of one or more indexes.
dtsSearchJob	Define a search to be performed.
dtsSearchReportJob	Describes a search report to be prepared from some or all of the items in a dtsSearchResults set.
dtsSearchResults	Provides access to the results of a search.
dtsSearchResultsItem	Properties of a single retrieved document from a search.
dtsTextBlock	Buffer to receive text extracted by a file parser.
dtsVerifyStatusInfo	Status of an index verify job.
dtsViewerInfo	Register an external file parser. See File Parser API
dtsWordListBuilder	Generates a list of words matching an expression, or surrounding a word in the index.

Functions

Function	Description
dtsRegisterViewer	An external file parser should call this function once at startup to register itself with the dtSearch Engine.
dtssConvertFile2	Convert a file to HTML, RTF, or text, optionally highlighting hits
dtssConvertPath2	Convert paths to local, virtual, or UNC
dtssDebugLogEx	Enable debug logging
dtssDeleteIndex	Delete an index
dtssDoIndexJob	Execute an index job
dtssDoSearchJob	Execute a search job: The search job to execute
dtssGetIndexInfo	Get information about an index
dtssGetOptions	Retrieve current option settings
dtssGetSynonyms	Generates a stream of XML containing synonym information for the specified word.
dtssInstallCrashDiagnostics	Install diagnostic handler for unhandled exceptions
dtssIntArrayDelete	Delete an integer array represented by a dtsStringHandle
dtssIntArrayGetItems	Get the contents of an integer array represented by a dtsStringHandle
dtssIntArrayGetLength	Get the length of an array represented by a dtsIntArrayHandle
dtssListIndex	List words, fields, or documents in an index
dtssMergeIndexes	Merge indexes
dtssRestoreCrashDiagnostics	Restore a previously-installed diagnostic handler that was overwritten by another component (such as a call to LoadLibrary that loads another DLL in the process)
dtssRemoveCrashDiagnostics	Remove diagnostic handler for unhandled exceptions (see dtsCrashHandlerInfo)
dtssSetOptions	Change option settings
dtssStringDelete	Free the memory allocated for a string that was returned as a dtsStringHandle
dtssStringGetLength	Get the length of a string represented by a dtsStringHandle
dtssStringGetText	Get the text of a string represented by a dtsStringHandle
dtssUtf8Decode	Convert UTF-8 to Unicode
dtssUtf8Encode	Convert Unicode to UTF-8
dtssVerifyIndex	Verify indexes
dtssVersion	Get the dtSearch Engine version. See dtssVersionEx for more detailed information.
dtssVersionEx	Get the dtSearch Engine version

Structs, Records, Enums

Struct, Record, Enum	Description
dtsContainerItemInfo	Stores information about a document that is contained in a container.
dtsConvertPathRequest	Used by dtssConvertPath2 to convert among virtual, local, and UNC paths
dtsCrashHandlerInfo	Used to install a crash handler so a stack trace can be recorded in the event of an unhandled exception
dtsDataSourceFileInfo	To be returned from dtsDataSource.getNextDocInfo or dtsDataSource.getFileInfoByName from a data source
dtsFileInfo	Used to package basic information about a file that a file parser must provide.
dtsIndexFileInfo	Contains information about a file being indexed.
dtsIndexInfo	Holds information about an index supplied by dtssGetIndexInfo.
dtsIndexProgressInfo	Reported through the status notification callback in a dtsIndexJob
dtsIndexInfoFlags	Indicates whether the index is case-sensitive, accent-sensitive, or uses relative paths
dtsIndexJobAction	Specifies whether to create, add documents to, compress, or remove items from an index in a dtsIndexJob.
dtsIndexJobCreateFlags	In a dtsIndexJob, specifies whether the index to create should be case-sensitive, accent-sensitive, or use relative paths
dtsSearchFileInfo	Information about a file being searched in an unindexed search.
dtsSearchJobAction	Describes action to perform in a dtsSearchJob
dtsSearchProgressInfo	Reported through the status notification callback in a dtsSearchJob, and the OnProgressUpdate virtual function callback in DSearchJob
dtsVersionInfo	Information returned by dtssVersionEx, which returns the dtSearch Engine version
dtsMessage	Structure passed to dtsJobBase.pReportCallBack to implement status notification callbacks. The meaning of the arguments depends on the "command" value, which is documented in the dtsMessageCode enum.
dtsOnIndexWordInfo	Used to modify words, or create additional words, as text is indexed.
dtsJobBase	Base class for dtsSearchJob, dtsIndexJob, dtsFileConvertJob, etc.

Types

Type	Description
dtsIndexCacheHandle	Handle to an index cache
dtsIntArrayHandle	Handle to an array of 32-bit integers
dtsSearchFilterHandle	Handle to a search filter
dtsSearchResultsHandle	Handle to a search results object
dtsStringHandle	Handle to a string
WordListBuilderHandle	Handle to a word list builder

Variables

Variable	Description
dtsMaxConfidence	Highest confidence level for file format recognition
dtsMaxSearchRequestLen	Maximum size of a search request
dtsMaxStoredFieldSize	Maximum allowed value for maxStoredFieldSize
dtsMaxWordsToRetrieveLimit	Maximum allowed value for maxWordsToRetrieve in dtsSearchJob and dtsOptions
maxTypeNameLen	For string type names in dtsFileInfo struct and dtsViewerInfo

Links

Legend, Topics, Classes, Functions, Structs, Records, Enums, Types, Variables