DListIndexJob Class

File

File: dtsfc.h

Namespace: dtSearch

Syntax

C++

class DListIndexJob : public DJobBase;

Data Members

Data Member	Description
IndexPath	Index to list
OutputFile	Name of file to create
OutputString	Destination for list, if SetOutputToString() was called.
ToMatch	ToMatch is an optional search expression specifying the text to match against items being listed. For example, to list all field names starting with "A", you would set SetListFlags(dtsListIndexFields), and set ToMatch to "A*".

Group

Classes

Members

Methods

Show:InheritedProtected

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. (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)
Execute	Called to execute a job. (Inherited from DJobBase)
Execute	Generate the list
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)
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)
OnQuestion	Not used (Inherited from DJobBase)
SetListFlags	ListIndexFlags specifying the type of list to generate
SetMaxSize	Maximum size of the output string to generate
SetOutputToString	Direct output to OutputString
SetSearchFlags	SearchFlags specifying search features to be used in matching the toMatch expression, such as fuzziness, stemming, etc
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase)
SuppressMessagePump	Do not pump waiting windows messages during callbacks (Inherited from DJobBase)
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
IndexPath	Index to list
OutputFile	Name of file to create
OutputString	Destination for list, if SetOutputToString() was called.
ToMatch	ToMatch is an optional search expression specifying the text to match against items being listed. For example, to list all field names starting with "A", you would set SetListFlags(dtsListIndexFields), and set ToMatch to "A*".

Methods

Show:InheritedProtected

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. (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)
Execute	Called to execute a job. (Inherited from DJobBase)
Execute	Generate the list
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)
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)
OnQuestion	Not used (Inherited from DJobBase)
SetListFlags	ListIndexFlags specifying the type of list to generate
SetMaxSize	Maximum size of the output string to generate
SetOutputToString	Direct output to OutputString
SetSearchFlags	SearchFlags specifying search features to be used in matching the toMatch expression, such as fuzziness, stemming, etc
SetTimeout	SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase)
SuppressMessagePump	Do not pump waiting windows messages during callbacks (Inherited from DJobBase)
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

List the contents of an index (words, files, or field names)

Class Hierarchy

dtSearch::DJobBase | dtSearch::DListIndexJob