You are here: C++ API > Enumerations > ErrorCodes Enumeration
Close
dtSearch Text Retrieval Engine Programmer's Reference
ErrorCodes Enumeration

File: dtsearch.h

Syntax
C++
enum ErrorCodes { dtsErOK = 0, dtsErAccIndex = 1, dtsAskDiskFullOverride = 2, dtsErOpenTemp = 3, dtsInfNoFilesToIndex = 4, dtsErIxWrongVersion = 5, dtsErIxInterrupted = 6, dtsErAccDirectory = 7, dtsErWorkDirFail = 8, dtsErAccFile = 9, dtsErFileCorrupt = 10, dtsErIndexFull = 11, dtsErPdfLzwNotLicensed = 12, dtsErTimeout = 13, dtsErCreateFailed = 14, dtsErCommitFailed = 15, dtsErFileNotFound = 16, dtsErFileEncrypted = 17, dtsErApiError = 18, dtsErDataSourceException = 19, dtsErBlankFilename = 20, dtsErFileEmpty = 21, dtsErInvalidHandle = 22, dtsErConflictingDocIdRanges = 23, dtsErLowMemory = 112, dtsErBadRequest = 116, dtsErSearchRequestEmpty = 117, dtsErSearchLimitReached = 120, dtsErNoFilesRetrieved = 122, dtsErRequestTooLong = 135, dtsErMaxWords = 137, dtsErWrFile = 143, dtsErDiskFull = 159, dtsErIxCorrupt = 162, dtsErAccessDenied = 177, dtsErOperationCancelled = 178, dtsErConnectFailed = 201, dtsErAccCachedDoc = 202, dtsErIndexingError = 203, dtsErOutOfMemory = 204, dtsErUnknownException = 205, dtsErContainerItemCorrupt = 206, dtsErContainerItemEncrypted = 207, dtsErContainerFormatUnsupported = 208, dtsErMergeIndexesNotCompatible = 209, dtsErIcuNotInitialized = 210, dtsErCmapFilesMissing = 211, dtsErStemmingRulesMissing = 212, dtsErAlphabetFileMissing = 213, dtsErWordNetMissing = 214, dtsErUserThesaurusMissing = 215, dtsErTextFieldTableMissing = 216, dtsErFileTypeTableFileMissing = 217, dtsErSegmentationRulesFileMissing = 218, dtsErNoiseWordFileMissing = 219, dtsErDtvPdfCryptoLibraryMissing = 220, dtsErDtvRarLibraryMissing = 221, dtsErIndexMissing = 222 };
Members
Description
dtsErOK = 0
No error
dtsErAccIndex = 1
Unable to access index
dtsAskDiskFullOverride = 2
If IndexingFlags.dtsCheckDiskSpace was set in an IndexJob, and if it appears that disk space is insufficient, then dtsAskDiskFullOverride will be sent to the error handler; the calling program should always allow the update to be cancelled in this case (the default action).
dtsErOpenTemp = 3
Unable to open temporary file.
dtsInfNoFilesToIndex = 4
Obsolete; no longer used.
dtsErIxWrongVersion = 5
Index built by incompatible version of dtSearch
dtsErIxInterrupted = 6
Obsolete; no longer used.
dtsErAccDirectory = 7
Unable to create or access directory
dtsErWorkDirFail = 8
Private directory is already locked
dtsErAccFile = 9
Unable to access input file
dtsErFileCorrupt = 10
File format error reading input file
dtsErIndexFull = 11
Index is full
dtsErPdfLzwNotLicensed = 12
Obsolete; no longer used.
dtsErTimeout = 13
Operation timed out (trigged by timeoutSeconds)
dtsErCreateFailed = 14
Unable to create index
dtsErCommitFailed = 15
Unable to commit changes to index
dtsErFileNotFound = 16
The document was not found in the index (returned when a document listed to be removed from an index is not found in the index)
dtsErFileEncrypted = 17
The document could not be accessed due to encryption
dtsErApiError = 18
Incorrectly configured API structure (for example, invalid dtSearchJob)
dtsErDataSourceException = 19
Exception thrown by data source
dtsErBlankFilename = 20
Filename is blank
dtsErFileEmpty = 21
File contains no data
dtsErInvalidHandle = 22
A handle passed to a dtSearch API function was invalid
dtsErConflictingDocIdRanges = 23
In an index merge, the flag dtsIndexKeepExistingDocIds was set and one or more indexes had overlapping doc id ranges
dtsErLowMemory = 112
Search halted due to low memory available
dtsErBadRequest = 116
Syntax error in search request
dtsErSearchRequestEmpty = 117
Search request is blank
dtsErSearchLimitReached = 120
Search halted because the autoStopLimit for the search job was reached
dtsErNoFilesRetrieved = 122
No files retrieved in search
dtsErRequestTooLong = 135
Search request was longer than dtsMaxSearchRequestLen
dtsErMaxWords = 137
Too many words retrieved in index
dtsErWrFile = 143
Unable to write output file
dtsErDiskFull = 159
Disk full -- indexing halted
dtsErIxCorrupt = 162
Index is corrupt
dtsErAccessDenied = 177
Access to the index was denied
dtsErOperationCancelled = 178
The operation was cancelled by the caller
dtsErConnectFailed = 201
Unable to connect to data source during indexing
dtsErAccCachedDoc = 202
Unable to access cached document in index
dtsErIndexingError = 203
Index update could not complete due to an error accessing the index
dtsErOutOfMemory = 204
An out-of-memory error occurred
dtsErUnknownException = 205
An unexpected exception occurred
dtsErContainerItemCorrupt = 206
An item stored inside a container format could not be extracted due to data corruption
dtsErContainerItemEncrypted = 207
An item stored inside a container format could not be extracted due to encryption
dtsErContainerFormatUnsupported = 208
A container could be be processed due to an unsupported file format
dtsErMergeIndexesNotCompatible = 209
One or more input indexes for a merge are not compatible with the target index (use IndexJob.CreateCompatibleIndexPath to create indexes that will be compatible with a target index for merging).
dtsErIcuNotInitialized = 210
The ICU library could not be loaded. Returned by Options.CheckConfiguration or dtssCheckConfiguration.
dtsErCmapFilesMissing = 211
CMAP files needed to process some PDF files are missing. Returned by Options.CheckConfiguration or dtssCheckConfiguration.
dtsErStemmingRulesMissing = 212
Options.StemmingRulesFile could not be read. Returned by Options.CheckConfiguration or dtssCheckConfiguration.
dtsErAlphabetFileMissing = 213
Options.AlphabetFile could not be read. Returned by Options.CheckConfiguration or dtssCheckConfiguration.
dtsErWordNetMissing = 214
The WordNet synonym database could not be opened. Returned by Options.CheckConfiguration or dtssCheckConfiguration.
dtsErUserThesaurusMissing = 215
Options.UserThesaurusFile could not be read. Returned by Options.CheckConfiguration or dtssCheckConfiguration.
dtsErTextFieldTableMissing = 216
Options.TextFieldsFile could not be read. Returned by Options.CheckConfiguration or dtssCheckConfiguration.
dtsErFileTypeTableFileMissing = 217
Options.FileTypeTableFile could not be read. Returned by Options.CheckConfiguration or dtssCheckConfiguration.
dtsErSegmentationRulesFileMissing = 218
Options.SegmentationRulesFile could not be read. Returned by Options.CheckConfiguration or dtssCheckConfiguration.
dtsErNoiseWordFileMissing = 219
Options.NoiseWordFile could not be read. Returned by Options.CheckConfiguration or dtssCheckConfiguration.
dtsErDtvPdfCryptoLibraryMissing = 220
The crypto-enabled PDF file parser could not be loaded. Returned by Options.CheckConfiguration or dtssCheckConfiguration.
dtsErDtvRarLibraryMissing = 221
The Rar file parser could not be loaded. Returned by Options.CheckConfiguration or dtssCheckConfiguration.
dtsErIndexMissing = 222
The index folder either does not exist or does not appear to contain an index

Error codes are returned after a job completes. In the C++ API, use the dtsErrorInfo attached to a job to access error codes. In .NET, use the Errors property of the job. In Java, use getErrors().

Copyright (c) 1995-2025 dtSearch Corp. All rights reserved.