DSearchResults Class

File

File: dtsfc.h

Namespace: dtSearch

Syntax

C++

class DSearchResults : public dtsSearchResults;

Data Members

	Name	Description
	DocDisplayName	User-friendly name for document selected by GetNthDoc
	DocHitCount	Number of hits in the document selected by GetNthDoc
	DocName	Name of the document selected by GetNthDoc
	DocTitle	Title of the document selected by GetNthDoc
	Request	Search request that generated this set of search results

Group

Classes

Members

Data Members

	Name	Description
	DocDisplayName	User-friendly name for document selected by GetNthDoc
	DocHitCount	Number of hits in the document selected by GetNthDoc
	DocName	Name of the document selected by GetNthDoc
	DocTitle	Title of the document selected by GetNthDoc
	Request	Search request that generated this set of search results

Operators

	Name	Description
	=	Copy search results

Methods

Show:Protected

No members matching the current filter

	Name	Description
	GetDocHits	Returns a pointer to an array of word offset of hits in the document selected by GetNthDoc
	GetDocInfoItem	Retrieves a single field from the field-value pairs containing document properties. For a list of the properties included, see dtsSearchResults::getDocInfoStrings Method
	GetNthDoc	Fills the document property members with information about one document in the search results.
	MakePdfWebHighlightFile	Generates hit highlighting data for Adobe Reader
	UrlDecodeItem	URL-decode an item in search results. An item is url-encoded by storing the index path, document id, and hit offsets. Decoding extracts these values from the url-encoded string.
	UrlEncodeItem	URL-encode an item in search results. An item is url-encoded by storing the index path, document id, and hit offsets. Some browsers and web servers are unable to handle very long URLs, so the string generated should be limited, using the maxLen parameter, to 1024 characters.
	getDocInfoItems	Field-value pairs containing document properties. For a list of the properties included, see dtsSearchResults::getDocInfoStrings Method
	getSelectedDoc	Returns the zero-based index of the currently-selected item in search results
	getSelections	Get the selection state of the items in search results
	initDocInfoStrings	Used to implement lazy initialization of the DocInfoString and DocInfoItems properties, which are collections of named properties that are time-consuming to construct and often not used.
	serializeFromXml	Read search results from an XML file
	sort	Sorts the search results set according to the SortFlags values in flags.

Methods

Show:Protected

No members matching the current filter

	Name	Description
	GetDocHits	Returns a pointer to an array of word offset of hits in the document selected by GetNthDoc
	GetDocInfoItem	Retrieves a single field from the field-value pairs containing document properties. For a list of the properties included, see dtsSearchResults::getDocInfoStrings Method
	GetNthDoc	Fills the document property members with information about one document in the search results.
	MakePdfWebHighlightFile	Generates hit highlighting data for Adobe Reader
	UrlDecodeItem	URL-decode an item in search results. An item is url-encoded by storing the index path, document id, and hit offsets. Decoding extracts these values from the url-encoded string.
	UrlEncodeItem	URL-encode an item in search results. An item is url-encoded by storing the index path, document id, and hit offsets. Some browsers and web servers are unable to handle very long URLs, so the string generated should be limited, using the maxLen parameter, to 1024 characters.
	getDocInfoItems	Field-value pairs containing document properties. For a list of the properties included, see dtsSearchResults::getDocInfoStrings Method
	getSelectedDoc	Returns the zero-based index of the currently-selected item in search results
	getSelections	Get the selection state of the items in search results
	initDocInfoStrings	Used to implement lazy initialization of the DocInfoString and DocInfoItems properties, which are collections of named properties that are time-consuming to construct and often not used.
	serializeFromXml	Read search results from an XML file
	sort	Sorts the search results set according to the SortFlags values in flags.

Operators

	Name	Description
	=	Copy search results

Legend

	Data Member
	Operator
	Method
	protected
	virtual

Description

Extends the dtsSearchResults class to add simpler access to string properties of retrieved documents.

Class Hierarchy