dtSearch::Engine::MessageCode Enumeration

Values for IndexProgressInfo.UpdateType and SearchProgressInfo.updateType

public enum MessageCode {
  dtsnSearchBegin = 2001,
  dtsnSearchDone,
  dtsnSearchWhere,
  dtsnSearchFound,
  dtsnSearchUpdateTime,
  dtsnSearchFileEncrypted,
  dtsnSearchFileCorrupt,
  dtsnSearchFileDone,
  dtsnIndexBegin = 3001,
  dtsnIndexDone,
  dtsnIndexCreate,
  dtsnIndexCheckingFiles,
  dtsnIndexToAddUpdate,
  dtsnIndexAdded,
  dtsnIndexStartingFile,
  dtsnIndexFileProgress,
  dtsnIndexFileDone,
  dtsnIndexFileOpenFail,
  dtsnIndexFileBinary,
  dtsnIndexMergeProgress,
  dtsnIndexCompressProgress,
  dtsnIndexFileEncrypted,
  dtsnIndexStoringWords,
  dtsnIndexStartingUpdate,
  dtsnIndexFilePartiallyEncrypted,
  dtsnIndexFilePartiallyCorrupt,
  dtsnAutoCommitBegin,
  dtsnAutoCommitDone,
  dtsnLastIndexStatusMessage = 3999,
  dtsnIndexMergeJobProgress,
  dtsnIndexVerifyProgress
}

Visual Basic

Public Enum MessageCode
  dtsnSearchBegin = 2001
  dtsnSearchDone
  dtsnSearchWhere
  dtsnSearchFound
  dtsnSearchUpdateTime
  dtsnSearchFileEncrypted
  dtsnSearchFileCorrupt
  dtsnSearchFileDone
  dtsnIndexBegin = 3001
  dtsnIndexDone
  dtsnIndexCreate
  dtsnIndexCheckingFiles
  dtsnIndexToAddUpdate
  dtsnIndexAdded
  dtsnIndexStartingFile
  dtsnIndexFileProgress
  dtsnIndexFileDone
  dtsnIndexFileOpenFail
  dtsnIndexFileBinary
  dtsnIndexMergeProgress
  dtsnIndexCompressProgress
  dtsnIndexFileEncrypted
  dtsnIndexStoringWords
  dtsnIndexStartingUpdate
  dtsnIndexFilePartiallyEncrypted
  dtsnIndexFilePartiallyCorrupt
  dtsnAutoCommitBegin
  dtsnAutoCommitDone
  dtsnLastIndexStatusMessage = 3999
  dtsnIndexMergeJobProgress
  dtsnIndexVerifyProgress
End Enum

Members

Members	Description
dtsnSearchBegin	Sent at the beginning of a search.
dtsnSearchDone	Sent at the end of a search
dtsnSearchWhere	Sent during a search to indicate what is being searched.
dtsnSearchFound	Sent when a file is retrieved in a search
dtsnSearchUpdateTime	Sent during a search periodically to update elapsed time display
dtsnSearchFileEncrypted	Sent during an unindexed search when the input document is encrypted
dtsnSearchFileCorrupt	Sent during an unindexed search when the input document is unreadable due to corruption
dtsnSearchFileDone	Sent during an unindexed search when the input document has been searched
dtsnIndexBegin	Start of an indexing job.
dtsnIndexDone	End of an indexing job
dtsnIndexCreate	Index is being created
dtsnIndexCheckingFiles	dtSearch is checking files to see if they need to be indexed.
dtsnIndexToAddUpdate	Update to amount of text to be indexed
dtsnIndexAdded	Update to number of files/bytes added so far
dtsnIndexStartingFile	Starting to index a file
dtsnIndexFileProgress	Indexing a file
dtsnIndexFileDone	File indexed successfully
dtsnIndexFileOpenFail	File could not be opened, either due to an access error or file format problem
dtsnIndexFileBinary	File not indexed because it is not in a recognized file format, and Options.BinaryFiles = dtsoIndexSkipBinary
dtsnIndexMergeProgress	Storing words in the index ("merge" in this context means merging into the main word list)
dtsnIndexCompressProgress	Compressing an index
dtsnIndexFileEncrypted	File could not be indexed because of encryption
dtsnIndexStoringWords	Words read from one or more files are being stored in the index
dtsnIndexStartingUpdate	Index update starting
dtsnIndexFilePartiallyEncrypted	Indicates that a file was indexed but that part of the file could not be accessed due to encryption
dtsnIndexFilePartiallyCorrupt	Indicates that a file was indexed but that part of the file could not be accessed due to data corruption
dtsnAutoCommitBegin	Sent when an automatic index commit is starting (automatic commits are triggered by autoCommitIntervalMB)
dtsnAutoCommitDone	Sent when an automatic index commit is complete (automatic commits are triggered by autoCommitIntervalMB)
dtsnIndexMergeJobProgress	Sent during a merge by dtsIndexMergeJob.
dtsnIndexVerifyProgress	Sent during a verify by dtsIndexVerifyJob

Remarks

The IIndexStatusHandler and ISearchStatusHandler2 interfaces support an OnProgressUpdate callback that can be used to monitor the progress of an index update or a search. MessageCode is used in that callback to indicate the meaning of each status update. In the indexing context the MessageCode is provided in IndexProgressInfo.UpdateType, and in the searching context the MessageCode is provided in SearchProgressInfo.UpdateType.