dtsMessageCode Enumeration

enum dtsMessageCode {
  dtsnCheckForAbort,
  dtsnRequestDraw,
  dtsnJobClose,
  dtsnFirstSearchStatusMessage = 2000,
  dtsnSearchBegin,
  dtsnSearchDone,
  dtsnSearchWhere,
  dtsnSearchFound,
  dtsnSearchUpdateTime,
  dtsnSearchFileEncrypted,
  dtsnSearchFileCorrupt,
  dtsnSearchFileDone,
  dtsnFirstIndexStatusMessage = 3000,
  dtsnIndexBegin = 3001,
  dtsnIndexDone,
  dtsnIndexCreate,
  dtsnIndexCheckingFiles,
  dtsnIndexToAddUpdate,
  dtsnIndexAdded,
  dtsnIndexStartingFile,
  dtsnIndexFileProgress,
  dtsnIndexFileDone,
  dtsnIndexFileOpenFail,
  dtsnIndexFileBinary,
  dtsnIndexMergeProgress,
  dtsnIndexCompressProgress,
  dtsnIndexFileEncrypted,
  dtsnIndexStoringWords,
  dtsnIndexStartingUpdate,
  dtsnIndexFilePartiallyEncrypted,
  dtsnIndexFilePartiallyCorrupt,
  dtsnAutoCommitBegin,
  dtsnAutoCommitDone,
  dtsnIndexMergeJobProgress,
  dtsnIndexVerifyProgress,
  dtsnFirstDiagnostic = 9000,
  dtsnInterimCommitBegin,
  dtsnInterimCommitDone
};

File

dtsearch.h

Members

Members	Description
dtsnCheckForAbort	Asks the calling application to give the user a chance to abort (i.e., check if the user has pressed a "cancel" button) Returns: dtsMessage.result = dtsContinue or dtsAbort
dtsnRequestDraw	Asks the calling application to update the screen display (not used)
dtsnJobClose	Last message sent through the pReportCallBack of a dtsIndexJob or dtsSearchJob. Signals that it is safe to delete any objects associated with the callback.
dtsnFirstSearchStatusMessage = 2000	Status notification messages (searching), prefix = dtsnSearch
dtsnSearchBegin	Sent at the beginning of a search. dtsMessage values: ptrParam: points to the dtsSearchJob.
dtsnSearchDone	Sent at the end of a search
dtsnSearchWhere	Sent during a search to indicate where we are searching dtsMessage values: strParam: name of file or index being searched ptrParam: a dtsSearchProgressInfo with details about the status of the search
dtsnSearchFound	Sent when a file is retrieved in a search. Set message.result = dtsVetoSearchResultsItem to prevent the item from being included in search results. dtsMessage values: strParam: name of the file paramA: number of hits in the file paramB: pointer to dtsSearchResultsItem with details about this item. ptrParam: a dtsSearchProgressInfo with details about the status of the search
dtsnSearchUpdateTime	Sent during a search periodically to update elapsed time display
dtsnSearchFileEncrypted	Sent during an unindexed search when the input document is encrypted. dtsMessage values: strParam: name of the file ptrParam: a dtsSearchProgressInfo with details about the status of the search, including details about the file
dtsnSearchFileCorrupt	Sent during an unindexed search when the input document is unreadable due to corruption. dtsMessage values: strParam: name of the file ptrParam: a dtsSearchProgressInfo with details about the status of the search, including details about the file.
dtsnSearchFileDone	Sent during an unindexed search when the input document has been searched. dtsMessage values: strParam: name of the file ptrParam: a dtsSearchProgressInfo with details about the status of the search, including details about the file
dtsnFirstIndexStatusMessage = 3000	Status notification messages (indexing), prefix = dtsnIndex
dtsnIndexBegin = 3001	Sent at the start of an indexing job. dtsMessage values: ptrParam: points to dtsIndexProgressInfo
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	Number of files/bytes indexed so far.
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 merge progress.
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)
dtsnIndexMergeJobProgress	Sent during a merge by dtsIndexMergeJob.
dtsnIndexVerifyProgress	Sent during a verify by dtsIndexVerifyJob
dtsnFirstDiagnostic = 9000	Diagnostic messages (internal use only)
dtsnInterimCommitBegin	deprecated, use dtsnAutoCommitBegin
dtsnInterimCommitDone	deprecated, use dtsnAutoCommitEnd

Description

Used in the "command" member of a dtsMessage to identify the purpose of a callback notification through the pReportCallBack function pointer in dtsJobBase.