C++ API
Classes
Class |
Description |
---|---|
Used by dtsIndexJob to index non-file data that is passed to the indexer through callbacks. | |
dtsExtractionOptions (attached to a dtsFileConvertJob2) specifies how embedded images and attachments should be handled. | |
Converts files to HTML, RTF, or text, optionally marking hits with caller-supplied tags. | |
Contains a file modification or creation time. File dates are always reported as UTC time. | |
Used to define a set of files to search or index | |
Sets dtSearch Engine indexing and searching option settings. | |
dtsOptionsReader is a simple class wrapper around dtsOptions2 to handle allocation of the data buffer used for variable-length values in dtsOptions2. | |
Describes an indexing task to be performed. | |
Passed to dtssMergeIndexes to merge two more indexes together. | |
Abstract interface to any source of document data. | |
Provides a layer of abstraction around a dtsInputStream. | |
Sets dtSearch Engine indexing and searching option settings. | |
Describes how you want a dtSearch search report to be generated. | |
Used to efficiently limit the results of a search to a specified subset of one or more indexes. | |
Define a search to be performed. | |
Describes a search report to be prepared from some or all of the items in a dtsSearchResults set. | |
Provides access to the results of a search. | |
Properties of a single retrieved document from a search. | |
Register an external file parser. See File Parser API | |
dtsWordListBuilder provides a way to list words, field names, or field values in an index. |
Functions
Function |
Description |
---|---|
An external file parser should call this function once at startup to register itself with the dtSearch Engine. | |
Validate that a dtSearch Engine application is correctly deployed. CheckConfiguration checks for missing components such as the ICU library, CMAP files, alphabet file, stemming rules, etc. Use CheckConfigurationFlags to specify the items to check. | |
Convert a file to HTML, RTF, or text, optionally highlighting hits | |
Convert paths to local, virtual, or UNC (Windows only) | |
Enable debug logging | |
Delete an index | |
Execute an index job | |
Execute a search job: The search job to execute | |
Get the status of the ICU library | |
Get information about an index | |
Retrieve current option settings | |
Get information about an index | |
Install diagnostic handler for unhandled exceptions | |
Retrieve current option settings | |
Delete an integer array represented by a dtsStringHandle | |
Generates a stream of XML containing synonym information for the specified word. | |
Get the contents of an integer array represented by a dtsStringHandle | |
Get the length of an array represented by a dtsIntArrayHandle | |
List words, fields, or documents in an index | |
Get partial contents of an integer array represented by a dtsStringHandle | |
Merge indexes | |
Remove diagnostic handler for unhandled exceptions (see dtsCrashHandlerInfo) | |
Change option settings | |
Free the memory allocated for a string that was returned as a dtsStringHandle | |
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) | |
Get the length of a string represented by a dtsStringHandle | |
Get the text of a string represented by a dtsStringHandle | |
Change option settings | |
Verify indexes | |
Get the dtSearch Engine version. See dtssVersionEx for more detailed information. | |
Convert UTF-8 to Unicode (deprecated: use dtssUtf8Decode2) | |
Get the dtSearch Engine version | |
Convert UTF-8 to Unicode (UTF-16) | |
Convert Unicode to UTF-8 (deprecated: use dtssUtf8Encode2) | |
Convert Unicode to UTF-8 |
Structs, Records, Enums
Struct, Record, Enum |
Description |
---|---|
Stores information about a document that is contained in a container. | |
Used by dtssConvertPath2 to convert among virtual, local, and UNC paths | |
Used to install a crash handler so a stack trace can be recorded in the event of an unhandled exception | |
Used to package basic information about a file that a file parser must provide. | |
To be returned from dtsDataSource.getNextDocInfo or dtsDataSource.getFileInfoByName from a data source | |
Indicates whether the index is case-sensitive, accent-sensitive, or uses relative paths | |
Specifies whether to create, add documents to, compress, or remove items from an index in a dtsIndexJob. | |
Holds information about an index supplied by dtssGetIndexInfo. | |
In a dtsIndexJob, specifies whether the index to create should be case-sensitive, accent-sensitive, or use relative paths | |
Reported through the status notification callback in a dtsIndexJob | |
Describes action to perform in a dtsSearchJob | |
Reported through the status notification callback in a dtsSearchJob, and the OnProgressUpdate virtual function callback in DSearchJob | |
Information returned by dtssVersionEx, which returns the dtSearch Engine version | |
... more | |
Values used in the Flags field for a file parser in filetype.xml. In filetype.xml, the numerical value must be used, not the constant name. | |
Contains information about a file being indexed. | |
dtsIndexVerifyJob is passed to dtssVerifyIndex, and is used to verify that an index is in good condition. | |
List words, fields, or filenames in an index to a file or to a memory buffer | |
Information passed to the makeViewer2 callback function in dtsViewerInfo | |
Status of a merge job in progress | |
Structure passed to dtsJobBase.pReportCallBack to implement status notification callbacks. | |
Used to modify words, or create additional words, as text is indexed. | |
Provides information about how to recognize a particular file type. | |
Information about a file being searched in an unindexed search. | |
Buffer to receive text extracted by a file parser. | |
Status of an index verify job. |
Topics
Topic |
Description |
---|---|
How to add the dtSearch Engine to a C++ project | |
How to add the dtSearch Engine to a C++ project under Linux | |
| |
Integrate an external language analyzer with the dtSearch Engine, to implement morphological analysis or word breaking. | |
Implements synonym expansion in an external DLL. | |
Use to add support for custom file formats to the dtSearch Engine | |
The following table lists classes in this documentation. | |
The following table lists functions in this documentation. | |
The following table lists structs, records, enums in this documentation. | |
The following table lists types in this documentation. | |
The following table lists variables in this documentation. |
Types
Type |
Description |
---|---|
Handle to a word list builder | |
Handle to an index cache | |
Handle to an array of 32-bit integers | |
Handle to a search filter | |
Handle to a search results object | |
Handle to a string |
Variables
Variable |
Description |
---|---|
Used with dtsIndexJob and dtsSearchJob to record errors that occur during indexing or searching. | |
Highest confidence level for file format recognition | |
Maximum size of a search request in bytes | |
Maximum allowed value for maxStoredFieldSize | |
Maximum allowed value for maxWordLength | |
Maximum allowed value for maxWordsToRetrieve in dtsSearchJob and dtsOptions | |
For string type names in dtsFileInfo struct and dtsViewerInfo |