Class wrapper around dtsIndexJob; used to create or update indexes.
File
File: dtsfc.h
Namespace: dtSearch
Syntax
Data Members
Data Member |
Description |
---|---|
Path to an index to use as a model when creating an index to ensure that the new index has options that are compatible with the other index. | |
deprecated Folder to use instead of the index folder for temporary files during indexing. During indexing, the dtSearch Engine may need to create temporary files to store word lists that are too large to fit into memory. By default, these files will be placed in the index folder. Use this setting to specify a different location for the word lists. The indexer will automatically delete the word list files when the index update completes. | |
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. | |
Filename filters specifying files not to be indexed. Documents in the FoldersToIndex are indexed if they are selected in IncludeFilters and not selected in ExcludeFilters. See Filename Filters | |
Name of file containing a list of files to be added to an index. | |
The directories or files to index. | |
Filename filters specifying files to be indexed. Documents in the FoldersToIndex are indexed if they are selected in IncludeFilters and not selected in ExcludeFilters. See Filename Filters | |
Name of the index. | |
Folder where the index files will be created. Each index must have its own folder. | |
Used to specify that the text in certain fields should be collected, stored in the index, and returned in searches. | |
Name of file containing a list of files to be removed from an index. | |
The dtsIndexJob that this DIndexJob object wraps. |
Group
Members
Methods
Show:
No members matching the current filter
Method |
Description |
---|---|
Add a folder to the list of folders to be indexed | |
Attach a data source to the index job. See dtsDataSource and DDataSourceBase | |
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. | |
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) | |
Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. | |
Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. (Inherited from DJobBase) | |
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) | |
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) | |
Resets the job to default values. | |
Called to execute a job. (Inherited from DJobBase) | |
Returns non-zero if the job failed (Inherited from DJobBase) | |
Format all errors that occurred during execution as a single string, with line breaks separating the errors (Inherited from DJobBase) | |
Returns the number of errors recorded during execution (Inherited from DJobBase) | |
Returns a dtsErrorInfo with any errors that occurred during execution (Inherited from DJobBase) | |
Returns true if the job has been cancelled (Inherited from DJobBase) | |
Returns true if the job has started and is not yet done. (Inherited from DJobBase) | |
Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DJobBase) | |
Called while a job is executing if an error is encountered, with the error code and message. (Inherited from DJobBase) | |
During indexing, OnProgressUpdate will be called frequently with information about the progress of the indexing job. | |
Not used (Inherited from DJobBase) | |
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). | |
Set the "compress" action in the index job (compress optimizes an index and removes obsolete information) | |
Set the "create" action in the index job (create a new, empty index before any other actions) | |
Clear all of the action flags (add, create, etc.) | |
Set the "remove deleted" action in the index job. Removing deleted documents cause the indexer to check whether each document in the index still exists, and to remove from the index any documents that no longer exist. | |
If the "remove listed" action is true, the files listed in ToRemoveListName will be removed from the index. | |
Set to true to create an accent-sensitive index. | |
Set to true to create a case-sensitive index | |
Set to true to create an index that uses relative paths | |
Set flag controlling how the index should be built. See IndexingFlags enumeration | |
Set flags controlling how the index should be built. See IndexingFlags enumeration | |
Limit the amount of memory that the indexer will use for workspace. nMegabytes is the number of megabytes to use, so 32 would mean 32 megabytes of memory. By default, the indexer will calculate how much memory to use based on the size of the document collection being indexed and the amount of physical RAM available (no more than 50% of the amount of physical RAM installed will be used). | |
SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase) | |
Do not pump waiting windows messages during callbacks (Inherited from DJobBase) | |
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) | |
Write an error message to the error handler object attached to this job (Inherited from DJobBase) |
Data Members
Data Member |
Description |
---|---|
Path to an index to use as a model when creating an index to ensure that the new index has options that are compatible with the other index. | |
deprecated Folder to use instead of the index folder for temporary files during indexing. During indexing, the dtSearch Engine may need to create temporary files to store word lists that are too large to fit into memory. By default, these files will be placed in the index folder. Use this setting to specify a different location for the word lists. The indexer will automatically delete the word list files when the index update completes. | |
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. | |
Filename filters specifying files not to be indexed. Documents in the FoldersToIndex are indexed if they are selected in IncludeFilters and not selected in ExcludeFilters. See Filename Filters | |
Name of file containing a list of files to be added to an index. | |
The directories or files to index. | |
Filename filters specifying files to be indexed. Documents in the FoldersToIndex are indexed if they are selected in IncludeFilters and not selected in ExcludeFilters. See Filename Filters | |
Name of the index. | |
Folder where the index files will be created. Each index must have its own folder. | |
Used to specify that the text in certain fields should be collected, stored in the index, and returned in searches. | |
Name of file containing a list of files to be removed from an index. | |
The dtsIndexJob that this DIndexJob object wraps. |
Topics
Topic |
Description |
---|---|
Add a folder to the FoldersToIndex list. |
Methods
Show:
No members matching the current filter
Method |
Description |
---|---|
Add a folder to the list of folders to be indexed | |
Attach a data source to the index job. See dtsDataSource and DDataSourceBase | |
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. | |
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) | |
Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. | |
Requests immediate termination of the job in progress. Indexing jobs will be halted without saving anything in the index. (Inherited from DJobBase) | |
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) | |
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) | |
Resets the job to default values. | |
Called to execute a job. (Inherited from DJobBase) | |
Returns non-zero if the job failed (Inherited from DJobBase) | |
Format all errors that occurred during execution as a single string, with line breaks separating the errors (Inherited from DJobBase) | |
Returns the number of errors recorded during execution (Inherited from DJobBase) | |
Returns a dtsErrorInfo with any errors that occurred during execution (Inherited from DJobBase) | |
Returns true if the job has been cancelled (Inherited from DJobBase) | |
Returns true if the job has started and is not yet done. (Inherited from DJobBase) | |
Called while a job is executing every time the dtSearch Engine checks to see if the job has been cancelled. (Inherited from DJobBase) | |
Called while a job is executing if an error is encountered, with the error code and message. (Inherited from DJobBase) | |
During indexing, OnProgressUpdate will be called frequently with information about the progress of the indexing job. | |
Not used (Inherited from DJobBase) | |
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). | |
Set the "compress" action in the index job (compress optimizes an index and removes obsolete information) | |
Set the "create" action in the index job (create a new, empty index before any other actions) | |
Clear all of the action flags (add, create, etc.) | |
Set the "remove deleted" action in the index job. Removing deleted documents cause the indexer to check whether each document in the index still exists, and to remove from the index any documents that no longer exist. | |
If the "remove listed" action is true, the files listed in ToRemoveListName will be removed from the index. | |
Set to true to create an accent-sensitive index. | |
Set to true to create a case-sensitive index | |
Set to true to create an index that uses relative paths | |
Set flag controlling how the index should be built. See IndexingFlags enumeration | |
Set flags controlling how the index should be built. See IndexingFlags enumeration | |
Limit the amount of memory that the indexer will use for workspace. nMegabytes is the number of megabytes to use, so 32 would mean 32 megabytes of memory. By default, the indexer will calculate how much memory to use based on the size of the document collection being indexed and the amount of physical RAM available (no more than 50% of the amount of physical RAM installed will be used). | |
SetTimeout() causes a job to cancel automatically after the specified number of seconds (Inherited from DJobBase) | |
Do not pump waiting windows messages during callbacks (Inherited from DJobBase) | |
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) | |
Write an error message to the error handler object attached to this job (Inherited from DJobBase) |
Topics
Topic |
Description |
---|---|
Add a folder to the FoldersToIndex list. |
Remarks
For more information on creating, updating, and maintaining indexes, see Building and Maintaining Indexes
Class Hierarchy
dtSearch::DJobBase
|
dtSearch::DIndexJob