DSearchJob Class

File

File: dtsfc.h

Namespace: dtSearch

Syntax

C++

class DSearchJob : public DJobBase;

Data Members

Data Member	Description
BooleanConditions	Additional boolean conditions that a document must meet to be retrieved in a search. See Search Requests for information on search request syntax.
ExcludeFilters	Filename filters specifying folders to be excluded from an unindexed search.
FieldWeights	Specify a relevance weight for hits that occur in listed fields (example: Subject:10,HtmlTitle:20)
FileConditions	File conditions that a document must meet to be retrieved in a search. See Search Requests for information on search request syntax.
FoldersToSearch	The FoldersToSearch, IncludeFilters, and ExcludeFilters specify files to be searched in an unindexed search.
IncludeFilters	In an unindexed search, the directories or files to search.
IndexesToSearch	One or more indexes to be searched. For each index, provide the full path to the index folder.
ListingName	If set to a filename, each file retrieved in the search will be written to this file. If the dtsSearchDelayDocInfo flag is set, the list will be built from the best-matching files after the search is done, sorted by relevance, and will contain at most MaxFiles items. Otherwise, the list will include all files retrieved in the search, in the order they were found.
Request	What you want to search for. See Search Requests for for information on search request syntax.

Group

Classes

Members

Methods

Show:InheritedProtected

No members matching the current filter

Method	Description
AddFolderToSearch	Add a folder to the FoldersToSearch list. Append <+> to the folder name to specify that subfolders should also be searched.
AddFolderToSearchU8	Add a folder to the FoldersToSearch list. Append <+> to the folder name to specify that subfolders should also be searched.
AddIndexToSearch	Add an index to the IndexesToSearch list.
AddIndexToSearchU8	Add an index to the IndexesToSearch list.
AttachDataSource	Attach a data source to the search job to be searched as part of an unindexed search.
Cancel	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. (Inherited from DJobBase)
CancelImmediate	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. (Inherited from DJobBase)
CancelImmediateWithReason	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
CancelWithReason	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
Clear	Resets the job to default values.
ClearSearchFlags	Clear all search flags in the SearchJob
CopyOutputSearchFilter	Copy the output search filter and return it.
DSearchJob	Constructor
DetachOutputSearchFilter	Detach the output search filter and return it.
DetachResults	Detach and return the search results generated by this search.
Execute	Called to execute a job. (Inherited from DJobBase)
Execute	Execute the search.
Failed	Returns non-zero if the job failed (Inherited from DJobBase)
FormatErrors	Format all errors that occurred during execution as a single string, with line breaks separating the errors (Inherited from DJobBase)
GetErrorCount	Returns the number of errors recorded during execution (Inherited from DJobBase)
GetErrors	Returns a dtsErrorInfo with any errors that occurred during execution (Inherited from DJobBase)
GetFuzziness	Returns the level of fuzziness in this search
GetMaxFiles	Returns the maximum files this search can retrieve.
GetResults	Return the search results generated by this search.
GetSearchFlag	Get the value of a single search flag
GetSearchFlags	Get all SearchFlags that were set for this search job.
GetSearchJob	Access the dtsSearchJob struct that DSearchJob wraps.
GetTotalFiles	Returns the total number of files that were retrieved in this search. If maxFilesToRetrieve was set, the value returned by GetTotalFiles may exceed the number of items in search results.
GetTotalHits	Returns the total number of hits in all files retrieved in this search.
IsCancelled	Returns true if the job has been cancelled (Inherited from DJobBase)
IsRunning	Returns true if the job has started and is not yet done. (Inherited from DJobBase)
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DJobBase)
OnError	Called while a job is executing if an error is encountered, with the error code and message. (Inherited from DJobBase)
OnFound(long, long, const char *, long, dtsSearchNotificationItem&)	Each time a document is retrieved, this function will be called.
OnFound(long, long, const char *, long, dtsSearchResultsItem&)
OnProgressUpdate	Called to update the status of a SearchJob
OnQuestion	Not used (Inherited from DJobBase)
OnSearchingFile	Called when an unindexed search begins searching a file.
OnSearchingIndex	This function will be called each time an index is searched. If several indexes are listed in IndexesToSearch, this function will be called once for each index.
SetAutoStopLimit	Request that a search automatically halt after more than a specified number of files have been retrieved
SetIndexCache	Set up search to use an index cache
SetItemScore	Changes the score associated with an item in search results.
SetMaxFiles	After a search, DSearchJob will return a DSearchResults object that contains up to this many files. If more files were retrieved than the MaxFilesToRetrieve value, only the best-matching files will be returned.
SetSearchFilter	Apply a search filter to the search that can be used to exclude or permit specified documents to be returned in search results. See: dtsSearchFilter.
SetSearchFlag	Set one of the SearchFlags values for this search.
SetSearchFlags	Set all SearchFlags values for this search.
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase)
SetUnindexedSearchFlags	Set UnindexedSearchFlags for this search
SetWantResultsAsFilter	Request a search filter containing the results of this search (see dtsSearchFilter)
SuppressMessagePump	Do not pump waiting windows messages during callbacks (Inherited from DJobBase)
VetoThisItem	Prevents a found document from being included in search results.
addCancelReason	Optional reason for job cancellation, purely for diagnostic purposes Checks to make sure the reason is not already present, and also guards against excessive string size in case of repetitive cancellations. (Inherited from DJobBase)
reportError	Write an error message to the error handler object attached to this job (Inherited from DJobBase)

Data Members

Data Member	Description
BooleanConditions	Additional boolean conditions that a document must meet to be retrieved in a search. See Search Requests for information on search request syntax.
ExcludeFilters	Filename filters specifying folders to be excluded from an unindexed search.
FieldWeights	Specify a relevance weight for hits that occur in listed fields (example: Subject:10,HtmlTitle:20)
FileConditions	File conditions that a document must meet to be retrieved in a search. See Search Requests for information on search request syntax.
FoldersToSearch	The FoldersToSearch, IncludeFilters, and ExcludeFilters specify files to be searched in an unindexed search.
IncludeFilters	In an unindexed search, the directories or files to search.
IndexesToSearch	One or more indexes to be searched. For each index, provide the full path to the index folder.
ListingName	If set to a filename, each file retrieved in the search will be written to this file. If the dtsSearchDelayDocInfo flag is set, the list will be built from the best-matching files after the search is done, sorted by relevance, and will contain at most MaxFiles items. Otherwise, the list will include all files retrieved in the search, in the order they were found.
Request	What you want to search for. See Search Requests for for information on search request syntax.

Methods

Show:InheritedProtected

No members matching the current filter

Method	Description
AddFolderToSearch	Add a folder to the FoldersToSearch list. Append <+> to the folder name to specify that subfolders should also be searched.
AddFolderToSearchU8	Add a folder to the FoldersToSearch list. Append <+> to the folder name to specify that subfolders should also be searched.
AddIndexToSearch	Add an index to the IndexesToSearch list.
AddIndexToSearchU8	Add an index to the IndexesToSearch list.
AttachDataSource	Attach a data source to the search job to be searched as part of an unindexed search.
Cancel	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. (Inherited from DJobBase)
CancelImmediate	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. (Inherited from DJobBase)
CancelImmediateWithReason	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
CancelWithReason	Requests termination of the job in progress. For indexing jobs, the job will be halted after information in documents already indexed is saved in the index. The reason parameter is purely for diagnostic purposes. (Inherited from DJobBase)
Clear	Resets the job to default values.
ClearSearchFlags	Clear all search flags in the SearchJob
CopyOutputSearchFilter	Copy the output search filter and return it.
DSearchJob	Constructor
DetachOutputSearchFilter	Detach the output search filter and return it.
DetachResults	Detach and return the search results generated by this search.
Execute	Called to execute a job. (Inherited from DJobBase)
Execute	Execute the search.
Failed	Returns non-zero if the job failed (Inherited from DJobBase)
FormatErrors	Format all errors that occurred during execution as a single string, with line breaks separating the errors (Inherited from DJobBase)
GetErrorCount	Returns the number of errors recorded during execution (Inherited from DJobBase)
GetErrors	Returns a dtsErrorInfo with any errors that occurred during execution (Inherited from DJobBase)
GetFuzziness	Returns the level of fuzziness in this search
GetMaxFiles	Returns the maximum files this search can retrieve.
GetResults	Return the search results generated by this search.
GetSearchFlag	Get the value of a single search flag
GetSearchFlags	Get all SearchFlags that were set for this search job.
GetSearchJob	Access the dtsSearchJob struct that DSearchJob wraps.
GetTotalFiles	Returns the total number of files that were retrieved in this search. If maxFilesToRetrieve was set, the value returned by GetTotalFiles may exceed the number of items in search results.
GetTotalHits	Returns the total number of hits in all files retrieved in this search.
IsCancelled	Returns true if the job has been cancelled (Inherited from DJobBase)
IsRunning	Returns true if the job has started and is not yet done. (Inherited from DJobBase)
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DJobBase)
OnError	Called while a job is executing if an error is encountered, with the error code and message. (Inherited from DJobBase)
OnFound(long, long, const char *, long, dtsSearchNotificationItem&)	Each time a document is retrieved, this function will be called.
OnFound(long, long, const char *, long, dtsSearchResultsItem&)
OnProgressUpdate	Called to update the status of a SearchJob
OnQuestion	Not used (Inherited from DJobBase)
OnSearchingFile	Called when an unindexed search begins searching a file.
OnSearchingIndex	This function will be called each time an index is searched. If several indexes are listed in IndexesToSearch, this function will be called once for each index.
SetAutoStopLimit	Request that a search automatically halt after more than a specified number of files have been retrieved
SetIndexCache	Set up search to use an index cache
SetItemScore	Changes the score associated with an item in search results.
SetMaxFiles	After a search, DSearchJob will return a DSearchResults object that contains up to this many files. If more files were retrieved than the MaxFilesToRetrieve value, only the best-matching files will be returned.
SetSearchFilter	Apply a search filter to the search that can be used to exclude or permit specified documents to be returned in search results. See: dtsSearchFilter.
SetSearchFlag	Set one of the SearchFlags values for this search.
SetSearchFlags	Set all SearchFlags values for this search.
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase)
SetUnindexedSearchFlags	Set UnindexedSearchFlags for this search
SetWantResultsAsFilter	Request a search filter containing the results of this search (see dtsSearchFilter)
SuppressMessagePump	Do not pump waiting windows messages during callbacks (Inherited from DJobBase)
VetoThisItem	Prevents a found document from being included in search results.
addCancelReason	Optional reason for job cancellation, purely for diagnostic purposes Checks to make sure the reason is not already present, and also guards against excessive string size in case of repetitive cancellations. (Inherited from DJobBase)
reportError	Write an error message to the error handler object attached to this job (Inherited from DJobBase)

Description

Class wrapper around dtsSearchJob; provides access to a simplified version of the searching interface.

Class Hierarchy

dtSearch::DJobBase | dtSearch::DSearchJob