DListIndexJob Class

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

class DListIndexJob : public DJobBase;

dtsfc.h

DListIndexJob Class

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.

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

DListIndexJob Class

Method	Description
Execute	Generate the list
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