IIndexJob Interface

Creates and updates indexes

File

File: dten600.idl

Module: COM Interface

Syntax

IDL

interface IIndexJob : IDispatch;

Group

Interfaces

Members

Properties

Property	Description
ActionAdd	Add documents to an existing index. If ActionCreate is not set, the index must already exist or the IndexJob will fail.
ActionCompress	Remove obsolete information from the index.
ActionCreate	Create a new index. If an index already exists in the specified directory, the index will be destroyed and replaced with a new, empty index.
ActionMerge	Merge the indexes listed in IndexesToMerge
ActionRemoveDeleted	Check that each file in the index still exists on disk and remove from the index any files that no longer exist.
ActionRemoveListed	Remove the files listed in the text file identified by ToRemoveListName from the index.
ActionVerify	Scan all index structures in the index to verify that the index is not damaged.
AllowConcurrentAccess	Obsolete (concurrent access is always enabled, regardless of the value of this setting)
AutoCommitIntervalMB	Number of megabytes to index before committing the index update.
CreateAccentSensitive	Create accent sensitive index, so accents on letters will be treated as significant when searching
CreateCaseSensitive	Create case sensitive index, so apple and Apple will be two different words.
CreateRelativePaths	Use relative rather than absolute paths in storing document locations.
DataSourceToIndex	The DataSourceToIndex property provides a way to supply text to be indexed to the dtSearch Engine when the text is not accessible as a disk file. You can use this to index databases with ADO, RDO, DAO, etc., or to index MAPI message stores with CDO. For more information, see "Indexing COM Data Sources".
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.
Errors	After an indexing job is done, the Errors property will contain a JobErrorInfo (IJobErrorInfo) object with any error messages generated during the indexing job.
ExecuteThreadHandle	When ExecuteInThread was called to start indexing, the thread id of the indexing thread
IndexName	Obsolete
IndexPath	Full path of the folder where the index is located.
IndexesToMerge	Indexes to merge into the target index, which is IndexPath. (ActionMerge must be true for the merge to occur.) For each index, provide the full path to the index. If more than one index path is provided, separate the paths with spaces. If a path contains a space, use quotation marks around the path. Example: ... more
IndexingFlags	Flags controlling how the indexing should be done. See the IndexingFlags enumeration.
IsThreadDone	Returns true if an indexing thread started by ExecuteInThread is done. IsThreadDoneWait will return immediately if the thread is done, or it will wait up to millisecondsToWait to return if the thread is not done yet. IsThreadDoneWait should be called when you are checking in a loop, so the indexing thread will have a chance to complete.
MaxMemToUseMB	MaxMemToUseMB controls the size of the memory buffers that dtSearch can use to sort words during indexing.
StartingDocId	First document id assigned, or to be assigned, in this index (will be 1 for an empty index)
StatusBytesIndexedKB	Kilobytes indexed so far
StatusBytesToIndexKB	Kilobytes to be indexed
StatusCurrentFileLocation	Location of the file being indexed
StatusCurrentFileName	Name of the file being indexed
StatusCurrentFilePercentDone	Percentage of the current file that has been indexed
StatusCurrentFileType	File type of the file being indexed
StatusDocsInIndex	Number of documents in the index
StatusHandler	Object to receive status update notifications during indexing. Can be used to provide a progress display and to provide an opportunity to cancel an index update.
StatusIndexingStep	IndexingStep value specifying the state of the indexer.
StatusPercentDone	Percentage of the index update that has been completed
StatusWordsInIndex	Number of words in the index
StoredFields	Fields to be stored in the index for each document and returned as document properties in SearchResults.
TempFileDir	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.
ToAddDir	Directory containing files to index. To specify a directory and its subdirectories, add <+> (less than, plus, greater than) following the directory name. To specify more than one directory, write the directory list to a file and use ToAddDirListName.
ToAddDirListName	File containing a list of directories to index. The list must be a text file containing one item per line. A directory name can have <+> after it to indicate that subfolders should also be searched. If any non-English characters appear in the directory names, the file must be encoded as UTF-8.
ToAddExcludeFilters	Filename filters specifying files not to be indexed. A file will be indexed if it matches one of the ToAddIncludeFilters and does not match any of the ToAddExcludeFilters.
ToAddFileListName	File containing a list of files to index. Can be used instead of or in addition to ToAddDirListName. The list must be a text file containing one filename. If any non-English characters appear in the filenames, the file must be encoded as UTF-8.
ToAddIncludeFilters	Filename filters specifying files to be indexed. A file will be indexed if it matches one of the ToAddIncludeFilters and does not match any of the ToAddExcludeFilters.
ToRemoveListName	Name of file containing list of files to remove from the index.

Methods

Method	Description
AbortThread	Aborts an indexing thread started by ExecuteInThread
AbortThreadImmediate	Aborts an indexing thread started by ExecuteInThread, without saving any changes to the index.
Execute	Performs the indexing job and returns 0 if the search is successful or -1 if an error occured.
ExecuteInThread	ExecuteInThread starts the indexing job in a separate thread and returns immediately.
GetIndexInfo	Returns a table of values describing the index in IndexPath.
IsThreadDoneWait	Returns true if an indexing thread started by ExecuteInThread is done. IsThreadDoneWait will return immediately if the thread is done, or it will wait up to millisecondsToWait to return if the thread is not done yet. IsThreadDoneWait should be called when you are checking in a loop, so the indexing thread will have a chance to complete.

Methods

Method	Description
AbortThread	Aborts an indexing thread started by ExecuteInThread
AbortThreadImmediate	Aborts an indexing thread started by ExecuteInThread, without saving any changes to the index.
Execute	Performs the indexing job and returns 0 if the search is successful or -1 if an error occured.
ExecuteInThread	ExecuteInThread starts the indexing job in a separate thread and returns immediately.
GetIndexInfo	Returns a table of values describing the index in IndexPath.
IsThreadDoneWait	Returns true if an indexing thread started by ExecuteInThread is done. IsThreadDoneWait will return immediately if the thread is done, or it will wait up to millisecondsToWait to return if the thread is not done yet. IsThreadDoneWait should be called when you are checking in a loop, so the indexing thread will have a chance to complete.

Properties

Property	Description
ActionAdd	Add documents to an existing index. If ActionCreate is not set, the index must already exist or the IndexJob will fail.
ActionCompress	Remove obsolete information from the index.
ActionCreate	Create a new index. If an index already exists in the specified directory, the index will be destroyed and replaced with a new, empty index.
ActionMerge	Merge the indexes listed in IndexesToMerge
ActionRemoveDeleted	Check that each file in the index still exists on disk and remove from the index any files that no longer exist.
ActionRemoveListed	Remove the files listed in the text file identified by ToRemoveListName from the index.
ActionVerify	Scan all index structures in the index to verify that the index is not damaged.
AllowConcurrentAccess	Obsolete (concurrent access is always enabled, regardless of the value of this setting)
AutoCommitIntervalMB	Number of megabytes to index before committing the index update.
CreateAccentSensitive	Create accent sensitive index, so accents on letters will be treated as significant when searching
CreateCaseSensitive	Create case sensitive index, so apple and Apple will be two different words.
CreateRelativePaths	Use relative rather than absolute paths in storing document locations.
DataSourceToIndex	The DataSourceToIndex property provides a way to supply text to be indexed to the dtSearch Engine when the text is not accessible as a disk file. You can use this to index databases with ADO, RDO, DAO, etc., or to index MAPI message stores with CDO. For more information, see "Indexing COM Data Sources".
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.
Errors	After an indexing job is done, the Errors property will contain a JobErrorInfo (IJobErrorInfo) object with any error messages generated during the indexing job.
ExecuteThreadHandle	When ExecuteInThread was called to start indexing, the thread id of the indexing thread
IndexName	Obsolete
IndexPath	Full path of the folder where the index is located.
IndexesToMerge	Indexes to merge into the target index, which is IndexPath. (ActionMerge must be true for the merge to occur.) For each index, provide the full path to the index. If more than one index path is provided, separate the paths with spaces. If a path contains a space, use quotation marks around the path. Example: ... more
IndexingFlags	Flags controlling how the indexing should be done. See the IndexingFlags enumeration.
IsThreadDone	Returns true if an indexing thread started by ExecuteInThread is done. IsThreadDoneWait will return immediately if the thread is done, or it will wait up to millisecondsToWait to return if the thread is not done yet. IsThreadDoneWait should be called when you are checking in a loop, so the indexing thread will have a chance to complete.
MaxMemToUseMB	MaxMemToUseMB controls the size of the memory buffers that dtSearch can use to sort words during indexing.
StartingDocId	First document id assigned, or to be assigned, in this index (will be 1 for an empty index)
StatusBytesIndexedKB	Kilobytes indexed so far
StatusBytesToIndexKB	Kilobytes to be indexed
StatusCurrentFileLocation	Location of the file being indexed
StatusCurrentFileName	Name of the file being indexed
StatusCurrentFilePercentDone	Percentage of the current file that has been indexed
StatusCurrentFileType	File type of the file being indexed
StatusDocsInIndex	Number of documents in the index
StatusHandler	Object to receive status update notifications during indexing. Can be used to provide a progress display and to provide an opportunity to cancel an index update.
StatusIndexingStep	IndexingStep value specifying the state of the indexer.
StatusPercentDone	Percentage of the index update that has been completed
StatusWordsInIndex	Number of words in the index
StoredFields	Fields to be stored in the index for each document and returned as document properties in SearchResults.
TempFileDir	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.
ToAddDir	Directory containing files to index. To specify a directory and its subdirectories, add <+> (less than, plus, greater than) following the directory name. To specify more than one directory, write the directory list to a file and use ToAddDirListName.
ToAddDirListName	File containing a list of directories to index. The list must be a text file containing one item per line. A directory name can have <+> after it to indicate that subfolders should also be searched. If any non-English characters appear in the directory names, the file must be encoded as UTF-8.
ToAddExcludeFilters	Filename filters specifying files not to be indexed. A file will be indexed if it matches one of the ToAddIncludeFilters and does not match any of the ToAddExcludeFilters.
ToAddFileListName	File containing a list of files to index. Can be used instead of or in addition to ToAddDirListName. The list must be a text file containing one filename. If any non-English characters appear in the filenames, the file must be encoded as UTF-8.
ToAddIncludeFilters	Filename filters specifying files to be indexed. A file will be indexed if it matches one of the ToAddIncludeFilters and does not match any of the ToAddExcludeFilters.
ToRemoveListName	Name of file containing list of files to remove from the index.

Remarks

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

To create or update an index, make an IndexJob, use the properties to describe the indexing task you want the engine to perform, and call the Execute method.

IndexJob provides two ways to specify the text to be indexed:

the ToAddXXX members let you specify directories and filename filters identifying a set of disk files to index, and the DataSourceToIndex member lets you supply text data directly to the dtSearch Engine for indexing.
DataSourceToIndex is useful for indexing data from non-file sources such as message stores, SQL databases, dynamically-generated data, or any non-file data accessible to your program. For more information, see "Indexing COM Data Sources"

Use the NewIndexJob method of the Server object to create a new IndexJob object.

Class Hierarchy

IIndexJob