Method 

Description 

execute 

Performs the indexing job and returns 0 if the job is successful or -1 if an error occured. 

getErrors 

After an indexing job is done, the Errors property will contain a JobErrorInfo object with any error messages generated during the indexing job. 

getIndexInfo 

Returns a table of values describing the index in IndexPath. 

getStatusIndexingStep 

Returns a number identifying the current indexing step in progress. The value will be one of the following:

• ixStepBegin (1) Indexing started
• ixStepCreatingIndex (2) Creating index
• ixStepCheckingFiles (3) Checking files to see which files need to be reindexed
• ixStepReadingFiles (4) Reading files
• ixStepStoringWords (5) Storing word references in the index
• ixStepMerging (6) Merging words into the index
• ixStepCompressing (7) Compressing the index to remove obsolete information
• ixStepMergingIndexes (9) Merging two or more indexes into a single index (if ActionMerge=true)
• ixStepVerifyingIndex(10) The index is being verified (if ActionVerify=true)
• ixStepDone (8) Done indexing

 

getStatusPercentDone 

Returns the percentage of the index job that has been completed. This value can be used during a callback through the StatusHandler property. 

setActionAdd 

Add documents to an index. 

setActionCompress 

Compress an index. 

setActionCreate 

Create an index. 

setActionMerge 

Merge two or more indexes. 

setActionRemoveDeleted 

Remove deleted documents from a index. 

setActionRemoveListed 

Remove a list of documents from an index. 

setActionVerify 

Verify that an index is not damaged. 

setAutoCommitIntervalMB 

Number of megabytes to index before committing the index update. 

setCreateAccentSensitive 

Index will preserve accents when indexing words. Otherwise, accents are stripped from words being indexed. Stripping of accents is done using information in the dtSearch alphabet file. 

setCreateCaseSensitive 

Index will treat words with different capitalization as different words. (apple and Apple would be two different words.) 

setCreateRelativePaths 

Use relative rather than absolute paths in storing document locations. 

setDataSourceToIndex 

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 or other non-file data. 

setExcludeFilters 

Files to skip during indexing. 

setFoldersToIndex 

Space-delimited list of folder names of folders to index. 

setIncludeFilters 

Summary
Files to index in the folders listed in FoldersToIndex
Remarks
A file will be indexed if it matches one of the IncludeFilters and does not match any of the ExcludeFilters. Each string can contain one or more filename filters, separated by spaces, to apply to files in the directories selected. (ExcludeFilters can be blank.) If a filename filter contains a space, put it in quotation marks. A filename filter that does not contain a backslash is compared to the name of each file. A filename filter that contains a backslash is compared to the fully-qualified pathname of each file.... more 

setIndexesToMerge 

List of indexes to merge into the target index (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:
  Example:  

setIndexingFlags 

IndexingFlags values controlling the indexing of documents 

setIndexName 

Name of the index 

setIndexPath 

The directory where the index will be stored. The index will consist of a set of files named INDEX_*.IX. 

setMaxMemToUseMB 

Amount of memory that the indexer should use for workspace (in megabytes). 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). At least 10 Mb is needed. 

setStartingDocId 

If non-zero, the first doc id to assign to documents in this index. 

setStatusHandler 

The statusHandler is an object that will receive status updates from the engine during indexing. This can be useful to give the user a status display (such as a progress bar) and an opportunity to cancel an indexing job in progress. The statusHandler object must implement a CheckForAbort method that returns int. If it returns 0, the index job continues. If it returns 1, the index job is halted after data indexed so far is saved. If it returns 2, the index job is halted immediately. On each callback, the value of getStatusPercentDone can be checked to update a progress... more 

setStoredFields 

Used to specify that the text in certain fields should be collected, stored in the index, and returned in searches. To specify the fields to be stored, set StoredFields to a space-delimited list of field names (quote any field names that contain spaces). The field names in the list can contain wildcards (* and ?). A set containing a single entry "*" would match all fields, causing the text of every field to be stored in the index. 

setTimeoutSeconds 

Set TimeoutSeconds to the maximum amount of time you want to permit the index job to run. The default value, zero, allows the index job to continue until cancelled or complete. 

setToRemoveListName 

Name of file containing list of files to remove from the index.