VDK mode error codes

All Verity Developer's Kit (VDK) API functions return an error code, and VdkSuccess is the successful return value. The following sections list the API error codes. These reflect actions of the cfcollection, cfindex, or cfsearch tags.

Generic error codes

Error code
No.
Description
VdkSuccess
(0)
Operation completed successfully.
VdkFail
(-2)
A general failure not covered by another API error code.
VdkWarn
(1)
A general warning.

Usage error codes

Error code
No.
Description
VdkError_BadArgStruct
(-10)
Invalid argument structure.
VdkError_BadHandleType
(-11)
Improper object type.
VdkError_HandleNotFound
(-12)
Object not found.
VdkError_MissingArgs
(-13)
Missing required arguments.
VdkError_InvalidArgs
(-14)
Invalid arguments.
VdkError_MultipleSesNew
(-16)
VdkSessionNew called twice.
VdkError_NestedService
(-17)
VdkService called reentrantly.
VdkError_NestedFree
(-18)
VdkSessionFree called reentrantly.
VdkError_Unsupported
(-19)
Using an unsupported feature.

Runtime error codes

Error code
No.
Description
VdkError_NoMsgDb
(-20)
Cannot find the message database.
VdkError_FatalError
(-21)
Fatal error.
VdkError_OutOfMemory
(-22)
Out of memory.
VdkError_DiskFull
(-23)
Out of disk space.
VdkError_NoFileHandles
(-24)
Out of file handles.
VdkError_InvalidDoc
(-25)
Bad document ID or key (internal or external).
VdkError_FileNotFound
(-26)
File not found.
VdkError_ArgTooLarge
(-27)
Argument too large.
VdkError_InvalidSortSpec
(-28)
Invalid sort specification.
VdkError_GatewayNotAvail
(-29)
Gateway driver not available.
VdkError_VersionMismatch
(-30)
Argument or object mismatch.
VdkError_NoInstallDir
(-100)
Cannot find installation directory.

Data error codes

Error code
No.
Description
VdkError_StyleFiles
(-31)
Invalid style files.
VdkError_Permissions
(-32)
Bad file or directory permission.
VdkError_CollNotAvail
(-33)
The collection is not available because it is down or under repair. This error occurs only when the Verity engine is attempting a submit action (for example, insert, update, or delete), to a collection. If this error is returned, the submit action does not occur.
VdkError_CollIll
(-34)
The collection is very sick.
VdkError_CollRepair
(-36)
The collection has been repaired.
VdkError_CollReadOnly
(-37)
This collection is read-only. No submits are allowed.
VdkError_CollPurge
(-38)
Purge failed due to problems deleting from any of the following directories: pdd, work, trans
VdkError_CollPathTooBig
(-39)
Collection path supplied for the path member in VdkCollectionOpenArgRec is too long. For more information, refer to the description of the VdkPath_MaxSize macro in your Verity documentation.
VdkError_V3Legacy
(-35)
Unsupported legacy collection(s).
VdkError_LocaleIncompat
(-101)
Collection and session locales are incompatible.
VdkError_KBNotOpened
(-102)
Knowledgebase is incompatible and cannot be opened.

Query error codes

Error code
No.
Description
VdkError_QueryParse
(-40)
Query has a parsing error.

Licensing error codes

Error code
No.
Description
VdkError_Signature
(-50)
Invalid/missing signature.
VdkError_LicenseFile
(-51)
Invalid license file.
VdkError_LicenseColl
(-52)
Too many collections open.
VdkError_LicenseVolume
(-53)
Too many documents in collection.
VdkError_LicenseAdvQuery
(-54)
No advanced query capability.
VdkError_LicenseHetero
(-56)
No heterogeneous collections.
VdkError_LicenseDataPrep
(-57)
Not licensed to index documents.
VdkError_LicenseStreams
(-58)
Not licensed for streams.
VdkError_LicenseTopics
(-59)
Not licensed for topics.
VdkError_LicenseThes
(-60)
Not licensed for thesaurus.
VdkError_LicenseAdvFeat
(-64)
Not licensed for advanced features.
VdkError_LicenseSesSpawn
(-65)
No spawning sessions.
VdkError_LicenseWatchers
(-66)
No watchers.
VdkError_LicenseAcrocoll
(-67)
No access to Acrobat.
VdkError_LicenseProfile
(-68)
No profilers.
VdkError_LicenseProfileLatency
(-69)
Low-speed profiler.
VdkError_LicensePrfCount
(-110)
Too many profiles.
VdkError_LicenseClustering
(-111)
No clustering.
VdkError_LicenseSummarization
(-112)
No summarization.
VdkError_LicenseNLQP
(-113)
No natural language queries.
VdkError_LicenseQBE
(-114)
No query-by-example.
VdkError_LicenseAdvSGML
(-115)
No support for advanced SGML search.
VdkError_LicenseZone
(-116)
No support for zone search.
VdkError_LicenseField
(-117)
No support for field search.
VdkError_LicenseAccrue
(-118)
No support for the ACCRUE operator.
VdkError_LicenseProximity
(-119)
No support for the proximity operators.
VdkError_LicenseStem
(-120)
No stemming.
VdkError_LicenseWildcard
(-121)
No support for wildcard queries.
VdkError_LicenseTypo
(-122)
No support for typo assist.
VdkError_LicenseOperator
(-123)
Unlicensed operator.
VdkError_LicenseInso
(-124)
Not licensed for INSO software.
VdkError_LicenseInvalid
(-125)
Invalid license.
VdkError_LicenseVgw
(-126)
No collection gateways.
VdkError_LicenseSoundex
(-127)
No support for Soundex queries.
VdkError_LicenseSentpara
(-128)
No support for SENTENCE or PARAGRAPH operators.
VdkError_Scoreop
(-129)
No support for Score operators.
VdkError_Opmod
(-130)
No support for query language modifiers.
VdkError_LicenseSession
(-131)
Too many top-level sessions.

Security error codes

Error code
No.
Description
VdkError_InvalidUser
(-80)
Invalid user/password combination.

Remote connection error codes

Error code
No.
Description
VdkError_HostNotAvail
(-90)
Cannot contact remote host.
VdkError_NotReEntrant
(-91)
Not reentrant.
VdkError_CallDenied
(-92)
Call cannot be executed.

Filtering error codes

Error code
No.
Description
VdkError_BadFile
(-140)
Corrupt or unreadable file.
VdkError_EmptyFile
(-141)
Empty file.
VdkError_ProtectedFile
(-142)
Password protected or encrypted file.
VdkError_FilterNotAvail
(-143)
No appropriate filter for a file format.
VdkError_FilterLoadFailed
(-144)
Error occurred during filter initialization.
VdkError_FileOpenFailed
(-145)
File could not be opened.

Dispatch error codes

Error code
No.
Description
VdkError_CouldntLoadDLL
(-200)
Cannot load DLL.
VdkError_NoSuchFunction
(-201)
Function not available.

Warning error codes

Error code
No.
Description
VdkWarning_CollectionDown
(10)
The collection was down when it was opened.
VdkWarning_QueryComplex
(11)
Too many matching words.
VdkWarning_LowMemory
(12)
Memory is low for indexing.
VdkWarning_CollectionReadOnly
(13)
The collection is read-only.
VdkWarning_DriverNotFound
(14)
Couldn't locate specified driver.
VdkWarning_LargeToken
(15)
Returned a token greater than maxSize.
VdkWarning_ArgTooLarge
(16)
Argument too large.
VdkWarning_DataSrcNotAvail
(17)
Cannot locate collection data.
VdkWarning_SearchRestricted
(18)
Search restricted to a subset of the collection.

Comments