MessageCode Enumeration

MessageCodes are sent to callback functions during an index or search to update the caller on the status of the job.

API

C++

Sent through dtsJobBase.pReportCallBack. See dtsMessage for documentation on structures passed to the callback.

.NET

Sent through IIndexStatusHandler and ISearchStatusHandler

Java

Sent through IIndexStatusHandler

File

File: dtsearch.h

Syntax

C++

enum MessageCode { dtsnCheckForAbort = 1001, dtsnJobClose = 1003, dtsnFirstSearchStatusMessage = 2000, dtsnSearchBegin, 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, dtsnIndexDeletedFileRemoved, dtsnIndexListedFileRemoved, dtsnIndexListedFileNotRemoved, dtsnIndexFolderInaccessible, dtsnIndexBeginThread, dtsnIndexEndThread, dtsnIndexMergeJobProgress, dtsnIndexVerifyProgress };

Members

Members	Description
dtsnCheckForAbort = 1001	Asks the calling application to give the user a chance to abort (i.e., check if the user has pressed a "cancel" button)
dtsnJobClose = 1003	Last message sent during execution of an index or search job.
dtsnFirstSearchStatusMessage = 2000
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 = 3001	Sent at the start of an indexing job.
dtsnIndexDone	Sent at the end of an indexing job.
dtsnIndexCreate	Sent when an index is being created.
dtsnIndexCheckingFiles	Sent as dtSearch is checking files to see if they need to be indexed.
dtsnIndexToAddUpdate	As dtSearch checks the list of files to be indexed, this message will be sent updating the amount of text to be indexed.
dtsnIndexAdded	Obsolete
dtsnIndexStartingFile	Sent when dtSearch is starting to index a file.
dtsnIndexFileProgress	Sent when starting to index a file, periodically as the file is indexed, and when the file is done.
dtsnIndexFileDone	Sent when a file has been completely read.
dtsnIndexFileOpenFail	Sent when an attempt to open a file fails.
dtsnIndexFileBinary	Sent when a file is not indexed because (1) it seems to be binary, and (2) indexing of binary files is turned off.
dtsnIndexMergeProgress	Sent to update the status of an index update during the "merging words" step.
dtsnIndexCompressProgress	Sent to update compression progress.
dtsnIndexFileEncrypted	Sent when a file is not indexed because it is encrypted.
dtsnIndexStoringWords	Sent when words are being written to disk for merging.
dtsnIndexStartingUpdate	Sent when an index update begins
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).
dtsnIndexDeletedFileRemoved	Sent when a file is removed from the index because it appears to have been deleted
dtsnIndexListedFileRemoved	Sent when a file is removed from the index because it was listed in the IndexJob to be removed
dtsnIndexListedFileNotRemoved	Sent when a file is NOT removed from the index, although it was listed in the IndexJob to be removed, because it was not found in the index
dtsnIndexFolderInaccessible	Sent when a folder could not be accessed to scan for documents to index
dtsnIndexBeginThread	First message sent from an indexing thread
dtsnIndexEndThread	Last message sent from an indexing thread
dtsnIndexMergeJobProgress	Sent during a merge
dtsnIndexVerifyProgress	Sent during verification of an index.

Group

Enumerations