dtsSearchResults Class

Provides access to the results of a search.

File

File: dtsearch.h

dtsSearchResults Constructor
urlDecode Method
urlEncode Method

Syntax

C++

class dtsSearchResults;

Group

Classes

Members

Operators

Operator	Description
=	Copy another search results object. This creates a deep copy, with its own handle.

Methods

Method	Description
addItem	Add a document to search results.
addItems	Add multiple documents to search results.
dtsSearchResults(const dtsSearchResults&)	Create a copy of another search results object. This creates a deep copy, with its own handle.
dtsSearchResults(dtsSearchResultsHandle, int)	Wrap an existing search results handle in a dtsSearchResults object
dtsSearchResults(long, long)	Constructor for a search results object
getCount	Returns the number of files in the search results set.
getDocInfo	Get one item from search results.
getDocInfoStrings	Generates a null-delimited string set containing field information associated with a document.
getFuzziness	Returns the fuzziness value used in the search that generated this set of results.
getHandle	getHandle() returns the handle that the dtSearch Engine uses internally to identify a search results set. The dtsSearchResults constructor allocates this handle and the dtsSearchResults destructor releases it, in both cases through calls to the dtSearch Engine API. To attach a dtsSearchResults object to a search job, set the search job's resultsHandle member to the value returned by getHandle().
getSearchDate	Returns the date the search was executed.
getSearchFlags	Returns the SearchFlags that were used in the search that generated this set of results.
getSearchRequest	Returns the search request in the search that generated this set of results.
getSelections	Retrieve the selection state of the items in the search results list.
getTotalFiles	Returns the number of files retrieved in the search, which may be more than the number actually stored in search results
getTotalHits	Returns the number of hits in all files retrieved in the search, which may be more than the number actually stored in search results
intersectionOf	Inserts into the current search results object only those items that are present in both A and B.
logDocInfo	internal use only
makePdfWebHighlightFile	Creates a string used to highlight hits in PDF files.
makeReport	Generate a search report from search results. A search report shows each hit with a specified amount of context, and can be in HTML, RTF, or plain text.
read	Read search results from an XML file.
readDocInfo	Read all document information records for items in this search results list.
serializeAsXml	serializeAsXml() encodes all of the data in a search results object as an XML stream and returns it using a dtsStringHandle. If iItem is -1, all of the items in search results are returned. If iItem is -2, only the XML describing the search results as a whole (the request, total hits, etc.) is returned. Otherwise, only the item indicated by iItem is returned.
serializeFromXml	serializeFromXml() extracts search results data from a stream generated by serializeAsXml.
setDocInfo	Change the values in a search results item
setSelections	Set the selection state of the items in the search results list.
setSortKey	Specify the string value to use when sorting search results.
sort	Sorts the search results set according to the SortFlags values in flags.
unionWith	Combines search results with another search results object, eliminating duplicate items.
urlDecode(const char *)	urlEncode generates a string encoding the contents of the currently selected item in search results. The string can be used in a subsequent call to urlDecode to re-create the search results item.
urlDecode(const char , const char )	urlEncode generates a string encoding the contents of the currently selected item in search results. The string can be used in a subsequent call to urlDecode to re-create the search results item.
urlEncode(int, char *, ptrdiff_t)	urlEncode generates a string encoding the contents of the currently selected item in search results. The string can be used in a subsequent call to urlDecode to re-create the search results item.
urlEncode(int, int, int)	urlEncode generates a string encoding the contents of the currently selected item in search results. The string can be used in a subsequent call to urlDecode to re-create the search results item.
urlEncode(int, int, int, int, const char *)	urlEncode generates a string encoding the contents of the currently selected item in search results. The string can be used in a subsequent call to urlDecode to re-create the search results item.
write	Save search results as an XML file.
writeSelected	Save search results as an XML file, saving only the items selected using setSelections.
~dtsSearchResults	Free the search results object

Methods

Method	Description
addItem	Add a document to search results.
addItems	Add multiple documents to search results.
dtsSearchResults(const dtsSearchResults&)	Create a copy of another search results object. This creates a deep copy, with its own handle.
dtsSearchResults(dtsSearchResultsHandle, int)	Wrap an existing search results handle in a dtsSearchResults object
dtsSearchResults(long, long)	Constructor for a search results object
getCount	Returns the number of files in the search results set.
getDocInfo	Get one item from search results.
getDocInfoStrings	Generates a null-delimited string set containing field information associated with a document.
getFuzziness	Returns the fuzziness value used in the search that generated this set of results.
getHandle	getHandle() returns the handle that the dtSearch Engine uses internally to identify a search results set. The dtsSearchResults constructor allocates this handle and the dtsSearchResults destructor releases it, in both cases through calls to the dtSearch Engine API. To attach a dtsSearchResults object to a search job, set the search job's resultsHandle member to the value returned by getHandle().
getSearchDate	Returns the date the search was executed.
getSearchFlags	Returns the SearchFlags that were used in the search that generated this set of results.
getSearchRequest	Returns the search request in the search that generated this set of results.
getSelections	Retrieve the selection state of the items in the search results list.
getTotalFiles	Returns the number of files retrieved in the search, which may be more than the number actually stored in search results
getTotalHits	Returns the number of hits in all files retrieved in the search, which may be more than the number actually stored in search results
intersectionOf	Inserts into the current search results object only those items that are present in both A and B.
logDocInfo	internal use only
makePdfWebHighlightFile	Creates a string used to highlight hits in PDF files.
makeReport	Generate a search report from search results. A search report shows each hit with a specified amount of context, and can be in HTML, RTF, or plain text.
read	Read search results from an XML file.
readDocInfo	Read all document information records for items in this search results list.
serializeAsXml	serializeAsXml() encodes all of the data in a search results object as an XML stream and returns it using a dtsStringHandle. If iItem is -1, all of the items in search results are returned. If iItem is -2, only the XML describing the search results as a whole (the request, total hits, etc.) is returned. Otherwise, only the item indicated by iItem is returned.
serializeFromXml	serializeFromXml() extracts search results data from a stream generated by serializeAsXml.
setDocInfo	Change the values in a search results item
setSelections	Set the selection state of the items in the search results list.
setSortKey	Specify the string value to use when sorting search results.
sort	Sorts the search results set according to the SortFlags values in flags.
unionWith	Combines search results with another search results object, eliminating duplicate items.
urlDecode(const char *)	urlEncode generates a string encoding the contents of the currently selected item in search results. The string can be used in a subsequent call to urlDecode to re-create the search results item.
urlDecode(const char , const char )	urlEncode generates a string encoding the contents of the currently selected item in search results. The string can be used in a subsequent call to urlDecode to re-create the search results item.
urlEncode(int, char *, ptrdiff_t)	urlEncode generates a string encoding the contents of the currently selected item in search results. The string can be used in a subsequent call to urlDecode to re-create the search results item.
urlEncode(int, int, int)	urlEncode generates a string encoding the contents of the currently selected item in search results. The string can be used in a subsequent call to urlDecode to re-create the search results item.
urlEncode(int, int, int, int, const char *)	urlEncode generates a string encoding the contents of the currently selected item in search results. The string can be used in a subsequent call to urlDecode to re-create the search results item.
write	Save search results as an XML file.
writeSelected	Save search results as an XML file, saving only the items selected using setSelections.
~dtsSearchResults	Free the search results object

Operators

Operator	Description
=	Copy another search results object. This creates a deep copy, with its own handle.

Remarks

A handle managed by the dtSearch Engine represents the search results, and dtsSearchResults calls dtSearch Engine API functions to obtain information using the handle and, in the destructor, to destroy the object represented by the handle.

Example

The following code sequence demonstrates the use of dtsSearchResults:

dtsSearchResults results; // Attach the dtsSearchResults object to the dtsSearchJob dtsSearchJob searchJob; searchJob.resultsHandle = results.getHandle(); // Execute the search ... set up rest of searchJob ... short errFlag; dtssDoSearchJob(searchJob, errFlag);

Class Hierarchy

dtsSearchResults