You are here: dtSearch.Engine > dtSearch::Engine::MessageCode Enumeration
dtSearch::Engine::MessageCode Enumeration
Close
dtSearch Engine API for .NET Framework 2.x-4.x
dtSearch::Engine::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

Syntax
C#
Visual Basic
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
Status notification messages (searching), prefix = dtsnSearch
dtsnSearchBegin = 2001
Sent at the beginning of a search
dtsnSearchDone = 2002
Sent at the end of a search
dtsnSearchWhere = 2003
Sent during a search to indicate what is being searched.
dtsnSearchFound = 2004
Sent when a file is retrieved in a search.
dtsnSearchUpdateTime = 2005
Sent during a search periodically to update elapsed time display.
dtsnSearchFileEncrypted = 2006
Sent during an unindexed search when the input document is encrypted.
dtsnSearchFileCorrupt = 2007
Sent during an unindexed search when the input document is unreadable due to corruption.
dtsnIndexBegin = 3001
Sent at the start of an indexing job.
dtsnIndexDone = 3002
Sent at the end of an indexing job.
dtsnIndexCreate = 3003
Sent when an index is being created.
dtsnIndexCheckingFiles = 3004
Sent as dtSearch is checking files to see if they need to be indexed.
dtsnIndexToAddUpdate = 3005
As dtSearch checks the list of files to be indexed, this message will be sent updating the amount of text to be indexed.
dtsnIndexAdded = 3006
Obsolete
dtsnIndexStartingFile = 3007
Sent when dtSearch is starting to index a file.
dtsnIndexFileProgress = 3008
Sent when starting to index a file, periodically as the file is indexed, and when the file is done.
dtsnIndexFileDone = 3009
Sent when a file has been completely read.
dtsnIndexFileOpenFail = 3010
Sent when an attempt to open a file fails.
dtsnIndexFileBinary = 3011
Sent when a file is not indexed because (1) it seems to be binary, and (2) indexing of binary files is turned off.
dtsnIndexMergeProgress = 3012
Sent to update the status of an index update during the "merging words" step.
dtsnIndexCompressProgress = 3013
Sent to update compression progress.
dtsnIndexFileEncrypted = 3014
Sent when a file is not indexed because it is encrypted.
dtsnIndexStoringWords = 3015
Sent when words are being written to disk for merging.
dtsnIndexStartingUpdate = 3016
Sent when an index update begins
dtsnIndexFilePartiallyEncrypted = 3017
Indicates that a file was indexed but that part of the file could not be accessed due to encryption.
dtsnIndexFilePartiallyCorrupt = 3018
Indicates that a file was indexed but that part of the file could not be accessed due to data corruption.
dtsnAutoCommitBegin = 3019
Sent when an automatic index commit is starting (automatic commits are triggered by autoCommitIntervalMB).
dtsnAutoCommitDone = 3020
Sent when an automatic index commit is complete (automatic commits are triggered by autoCommitIntervalMB).
dtsnIndexDeletedFileRemoved = 3021
Sent when a file is removed from the index because it appears to have been deleted
dtsnIndexListedFileRemoved = 3022
Sent when a file is removed from the index because it was listed in the IndexJob to be removed
dtsnIndexListedFileNotRemoved = 3023
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 = 3024
Sent when a folder could not be accessed to scan for documents to index
dtsnIndexMergeJobProgress = 4000
Sent during a merge
dtsnIndexVerifyProgress = 4001
Sent during verification of an index.
Copyright (c) 1998-2018 dtSearch Corp. All rights reserved.