DJobBase Class

Base class for DFileConverter, DIndexJob, DIndexMergeJob, DIndexListJob, DSearchJob, and DSearchReportJob.

File

File: dtsfc.h

Namespace: dtSearch

Syntax

C++

class DJobBase;

Group

Classes

Members

Methods

Show:Protected

No members matching the current filter

Method	Description
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.
CancelImmediate	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index.
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.
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.
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
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.
reportError	Write an error message to the error handler object attached to this job

Methods

Show:Protected

No members matching the current filter

Method	Description
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.
CancelImmediate	Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index.
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.
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.
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
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.
reportError	Write an error message to the error handler object attached to this job

Remarks

DJobBase provides common task-management functions for starting, monitoring, and cancelling a job, and for obtaining error information after a job completes.

The Job classes include several callback methods implemented as virtual functions, such as OnCheckAbort and OnError (in all classes), OnProgressUpdate (DIndexJob), and OnFound (DSearchJob). To use these methods, create a class based on the underlying Job class and override the virtual function you want to implement.

class CMySearchJob : public DSearchJob { public: ... virtual void OnError(long errorCode, const char *msg) { // First call base class implementation DSearchJob::OnError(errorCode, msg); // Now show the message to the user CString csMsg = GetMyErrorForErrorCode(errorCode); ShowMessageToUser(csMsg); } virtual void OnFound(long totalFiles, long totalHits, const char *name, long hitsInFile, dtsSearchResultsItem& item) { // First call base class implementation DSearchJob::OnFound(totalFiles, totalHits, name, hitsInFile, item); // Now show the file to the user ShowFoundFileToUser(name); } };

Class Hierarchy

dtSearch::DJobBase