DIndexJob Class

Class wrapper around dtsIndexJob; used to create or update indexes.

class DIndexJob : public DJobBase;

File

dtsfc.h

Remarks

For more information on creating, updating, and maintaining indexes, see Building and Maintaining Indexes

Data Members

DIndexJob Class

Data Member	Description
DirListName	deprecated Folder to use instead of the index folder for temporary files during indexing.
EnumerableFields	Used to specify that the text in certain fields should be stored in the index in a way that permits unique field values to be enumerated quickly.
ExcludeFilters	Filename filters specifying files not to be indexed.
FileListName	Name of file containing a list of files to be added to an index.
FoldersToIndex	The directories or files to index.
IncludeFilters	Filename filters specifying files to be indexed.
indexJob	The dtsIndexJob that this DIndexJob object wraps.
IndexName	Name of the index.
IndexPath	Folder where the index files will be created.
StoredFields	Used to specify that the text in certain fields should be collected, stored in the index, and returned in searches.
ToRemoveListName	Name of file containing a list of files to be removed from an index.

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

DIndexJob Class

Method	Description
AddFolderToIndex	Add a folder to the list of folders to be indexed
AttachDataSource	Attach a data source to the index job. See dtsDataSource and DDataSourceBase
Cancel	Requests termination of the job in progress.
CancelImmediate	Requests immediate termination of the job in progress.
Clear	Resets the job to default values.
Execute	Execute the indexing job.
OnProgressUpdate	During indexing, OnProgressUpdate will be called frequently with information about the progress of the indexing job.
SetActionAdd	Set the "add" action flag for the IndexJob (index documents that are not currently in the index, or that have been modified since they were last indexed).
SetActionCompress	Set the "compress" action in the index job (compress optimizes an index and removes obsolete information)
SetActionCreate	Set the "create" action in the index job (create a new, empty index before any other actions)
SetActionNone	Clear all of the action flags (add, create, etc.)
SetActionRemoveDeleted	Set the "remove deleted" action in the index job.
SetActionRemoveListed	If the "remove listed" action is true, the files listed in ToRemoveListName will be removed from the index.
SetFlagCreateAccentSensitive	Set to true to create an accent-sensitive index.
SetFlagCreateCaseSensitive	Set to true to create a case-sensitive index
SetFlagCreateRelativePaths	Set to true to create an index that uses relative paths
SetIndexingFlags	Set flags controlling how the index should be built.
SetMaxMemToUseMB	Limit the amount of memory that the indexer will use for workspace.

Legend

	Method
	virtual
	abstract
	Data Member

Links

Data Members, Classes, Legend, Members, Methods