DSearchJob Class

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

class DSearchJob : public DJobBase;

File

dtsfc.h

Data Members

DSearchJob Class

Data Member	Description
BooleanConditions	Additional boolean conditions that a document must meet to be retrieved in a search.
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.
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.
ListingName	If set to a filename, each file retrieved in the search will be written to this file.
Request	What you want to search for.

Group

Classes

Methods

Method	Description
Cancel	Requests termination of the job in progress.
CancelImmediate	Requests immediate termination of the job in progress.
Execute	Called to execute a job.
Failed	Returns non-zero if the job failed
FormatErrors	Format all errors that occurred during execution as a single string, with line breaks separating the errors
GetErrorCount	Returns the number of errors recorded during execution
GetErrors	Returns a dtsErrorInfo with any errors that occurred during execution
IsCancelled	Returns true if the job has been cancelled
IsRunning	Returns true if the job has started and is not yet done.
OnCheckAbort	Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled.
OnError	Called while a job is executing if an error is encountered, with the error code and message.
OnQuestion	Not used
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds
SuppressMessagePump	Do not pump waiting windows messages during callbacks

DSearchJob Class

Method	Description
AddFolderToSearch	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.
AttachDataSource	Attach a data source to the search job to be searched as part of an unindexed search.
Clear	Resets the job to default values.
ClearSearchFlags	Clear all search flags in the SearchJob
CopyOutputSearchFilter	Copy the output search filter and return it.
DetachOutputSearchFilter	Detach the output search filter and return it.
DetachResults	Detach and return the search results generated by this search.
DSearchJob	Constructor
Execute	Execute the search.
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.
GetTotalHits	Returns the total number of hits in all files retrieved in this search.
OnFound	This is the overview for the OnFound method overload.
OnProgressUpdate	Called to update the status of a SearchJob
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
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.
SetSearchFlag	Set one of the SearchFlags values for this search.
SetSearchFlags	Set all SearchFlags values for this search.
SetUnindexedSearchFlags	Set UnindexedSearchFlags for this search
SetWantResultsAsFilter	Request a search filter containing the results of this search (see dtsSearchFilter)
VetoThisItem	Prevents a found document from being included in search results.

Legend

	Method
	virtual
	abstract
	Data Member

Links

Data Members, Classes, Legend, Members, Methods, OnFound Method