MessageCode Class

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: MessageCode.java

Package: com.dtsearch.engine

Syntax

Java

public class MessageCode;

Fields

Field	Description
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).
dtsnCheckForAbort	Asks the calling application to give the user a chance to abort (i.e., check if the user has pressed a "cancel" button)
dtsnFirstSearchStatusMessage	Status notification messages (searching), prefix = dtsnSearch
dtsnIndexAdded	Obsolete
dtsnIndexBegin	Sent at the start of an indexing job.
dtsnIndexBeginThread	First message sent from an indexing thread
dtsnIndexCheckingFiles	Sent as dtSearch is checking files to see if they need to be indexed.
dtsnIndexCompressProgress	Sent to update compression progress.
dtsnIndexCreate	Sent when an index is being created.
dtsnIndexDeletedFileRemoved	Sent when a file is removed from the index because it appears to have been deleted
dtsnIndexDone	Sent at the end of an indexing job.
dtsnIndexEndThread	Last message sent from an indexing thread
dtsnIndexFileBinary	Sent when a file is not indexed because (1) it seems to be binary, and (2) indexing of binary files is turned off.
dtsnIndexFileDone	Sent when a file has been completely read.
dtsnIndexFileEncrypted	Sent when a file is not indexed because it is encrypted.
dtsnIndexFileOpenFail	Sent when an attempt to open a file fails.
dtsnIndexFilePartiallyCorrupt	Indicates that a file was indexed but that part of the file could not be accessed due to data corruption.
dtsnIndexFilePartiallyEncrypted	Indicates that a file was indexed but that part of the file could not be accessed due to encryption.
dtsnIndexFileProgress	Sent when starting to index a file, periodically as the file is indexed, and when the file is done.
dtsnIndexFolderInaccessible	Sent when a folder could not be accessed to scan for documents to index
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
dtsnIndexListedFileRemoved	Sent when a file is removed from the index because it was listed in the IndexJob to be removed
dtsnIndexMergeJobProgress	Sent during a merge
dtsnIndexMergeProgress	Sent to update the status of an index update during the "merging words" step.
dtsnIndexStartingFile	Sent when dtSearch is starting to index a file.
dtsnIndexStartingUpdate	Sent when an index update begins
dtsnIndexStoringWords	Sent when words are being written to disk for merging.
dtsnIndexToAddUpdate	As dtSearch checks the list of files to be indexed, this message will be sent updating the amount of text to be indexed.
dtsnIndexVerifyProgress	Sent during verification of an index.
dtsnJobClose	Last message sent during execution of an index or search job.
dtsnSearchBegin	Sent at the beginning of a search
dtsnSearchDone	Sent at the end of a search
dtsnSearchFileCorrupt	Sent during an unindexed search when the input document is unreadable due to corruption.
dtsnSearchFileEncrypted	Sent during an unindexed search when the input document is encrypted.
dtsnSearchFound	Sent when a file is retrieved in a search.
dtsnSearchUpdateTime	Sent during a search periodically to update elapsed time display.
dtsnSearchWhere	Sent during a search to indicate what is being searched.

Class Hierarchy

com.dtsearch.engine.MessageCode