KVErrorCode

This enumerated type defines the type of error generated if Filter fails. This enumerated type is defined in kverrorcodes.h.

Definition

typedef enum
{
    KVError_Success,                    /*  0 */
    KVError_DLLNotFound,                /*  1 */
    KVError_OutOfCore,                  /*  2 */
    KVError_ProcessCancelled,           /*  3 */
    KVError_BadInputStream,             /*  4 */
    KVError_BadOutputType,              /*  5 */
    KVError_General,                    /*  6 */
    KVError_FormatNotSupported,         /*  7 */
    KVError_PasswordProtected,          /*  8 */
    KVError_ADSNotFound,                /*  9 */
    KVError_AutoDetFail,                /* 10 */
    KVError_AutoDetNoFormat,            /* 11 */
    KVError_ReaderInitError,            /* 12 */
    KVError_NoReader,                   /* 13 */
    KVError_CreateOutputFileFailed,     /* 14 */
    KVError_CreateTempFileFailed,       /* 15 */
    KVError_ErrorWritingToOutputFile,   /* 16 */
    KVError_CreateProcessFailed,        /* 17 */
    KVError_WaitForChildFailed,         /* 18 */
    KVError_ChildTimeOut,               /* 19 */
    KVError_ArchiveFileNotFound,        /* 20 */
    KVError_ArchiveFatalError,          /* 21 */
    KVError_OpenStreamFailure,          /* 22 */
    KVError_InterfaceFunctionNotFound,  /* 23 */
    KVError_InputFileNotFound,          /* 24 */
    KVError_OpenOutputFileFailed,       /* 25 */
    KVError_MemoryLeak,                 /* 26 */
    KVError_MemoryOverwrite,            /* 27 */
    KVError_GPF,                        /* 28 */
    KVError_OopCore,                    /* 29 */
    KVError_KVoopLogFailed,             /* 30 */
    KVError_OverNestedFileLimit,        /* 31 */
    KVError_PSTAccessFailed,            /* 32 */
    KVError_PasswordRequired,           /* 33 */
    KVError_InvalidArgs,                /* 34 */
    KVError_ReaderUsageDenied,          /* 35 */
    KVError_OopBadConfig,               /* 36 */
    KVError_OopBrokenPipe,              /* 37 */
    KVError_OopPipeOEF,                 /* 38 */
    KVError_IPCTimeOut,                 /* 39 */
    KVError_InvalidOopDriverSignature,  /* 40 */
    KVError_InvalidOopServiceSignature, /* 41 */
    KVError_ZeroFile,                   /* 42 */
    KVError_CompressionNotSupported,    /* 43 */
    KVError_NoTemplates,                /* 44 */
    KVError_NoMainTemplate,             /* 45 */
    KVError_InvalidTemplate,            /* 46 */
    KVError_TemplateError,              /* 47 */
    KVError_IsADirectory,               /* 48 */
    KVError_RMSDecryptionFailed,        /* 49 */
    KVError_InvalidLicense,             /* 50 */
    KVError_RMSCredentialsRequired,     /* 51 */
    KVError_InvalidConfigurationFile,   /* 52 */
    KVError_UnexpectedAppendedZip,      /* 53 */
    KVError_ExpiredLicense,             /* 54 */
    KVError_Last,                       /* 55 */

    KVERR_Success =                     KVError_Success,
    KVERR_DLLNotFound =                 KVError_DLLNotFound,
    KVERR_OutOfCore =                   KVError_OutOfCore,
    KVERR_processCancelled =            KVError_ProcessCancelled,
    KVERR_badInputStream =              KVError_BadInputStream,
    KVERR_badOutputType =               KVError_BadOutputType,
    KVERR_General =                     KVError_General,
    KVERR_FormatNotSupported =          KVError_FormatNotSupported,
    KVERR_PasswordProtected =           KVError_PasswordProtected,
    KVERR_ADSNotFound =                 KVError_ADSNotFound,
    KVERR_AutoDetFail =                 KVError_AutoDetFail,
    KVERR_AutoDetNoFormat =             KVError_AutoDetNoFormat,
    KVERR_ReaderInitError =             KVError_ReaderInitError,
    KVERR_NoReader =                    KVError_NoReader,
    KVERR_CreateOutputFileFailed =      KVError_CreateOutputFileFailed,
    KVERR_CreateTempFileFailed =        KVError_CreateTempFileFailed,
    KVERR_ErrorWritingToOutputFile =    KVError_ErrorWritingToOutputFile,
    KVERR_CreateProcessFailed =         KVError_CreateProcessFailed,
    KVERR_WaitForChildFailed =          KVError_WaitForChildFailed,
    KVERR_ChildTimeOut =                KVError_ChildTimeOut,
    KVERR_ArchiveFileNotFound =         KVError_ArchiveFileNotFound,
    KVERR_ArchiveFatalError =           KVError_ArchiveFatalError
}
KVErrorCode, KVErrorCodeEx;

Enumerators

KVError_Success	The function completed successfully.
KVError_DLLNotFound	A DLL or shared library was not found.
KVError_OutOfCore	Memory allocation failure.
KVError_ProcessCancelled	The callback function fpContinue() returns FALSE.
KVError_BadInputStream	Invalid or corrupt input stream.
KVError_BadOutputType	Invalid output is requested.
KVError_General	General error.
KVError_FormatNotSupported	The file format is not supported.
KVError_PasswordProtected	The file is encrypted or password-protected. KeyView supports only secure PST files.
KVError_ADSNotFound	Adobe Document Server not found. This error is obsolete.
KVError_AutoDetFail	Autodetect error.
KVError_AutoDetNoFormat	Unable to detect file format.
KVError_ReaderInitError	Error initializing the reader.
KVError_NoReader	No reader is available for this format.
KVError_CreateOutputFileFailed	Unable to create output file. This error is generated if the overwrite flag in KVExtractSubFileArg is FALSE, and a subfile has the same name as a file in the target path.
KVError_CreateTempFileFailed	Unable to create temporary file.
KVError_ErrorWritingToOutputFile	There was an error writing to the output file.
KVError_CreateProcessFailed	There was an error creating a child process.
KVError_WaitForChildFailed	The wait for child process failed.
KVError_ChildTimeOut	The child process hung or timed out.
KVError_ArchiveFileNotFound	Attempt to extract nonexistent file.
KVError_ArchiveFatalError	A fatal error occurred processing an archive file.
KVError_OpenStreamFailure	Failed to open a stream during out-of-process filtering.
KVError_InterfaceFunctionNotFound	An interface function was not found during out-of-process filtering.
KVError_InputFileNotFound	Could not find the input file during out-of-process filtering.
KVError_OpenOutputFileFailed	Could not open the output file during out-of-process filtering.
KVError_MemoryLeak	A memory leak occurred during out-of-process filtering.
KVError_MemoryOverwrite	A memory overwrite occurred during out-of-process filtering.
KVError_GPF	An exception occurred during out-of-process filtering.
KVError_OopCore	A memory dump was generated in a child process during out-of-process filtering.
KVError_KVoopLogFailed	The creation of the out-of-process error log failed.
KVError_OverNestedFileLimit	The container file has more than the allowable number of child documents. One or more child documents were not converted. Currently, this enumerator is not used.
KVError_PSTAccessFailed	The PST file could not be converted. This error might be returned when a call to fpOpenFile() returns NULL for one of the following reasons: A Microsoft Outlook client is not installed. A Microsoft Outlook client is installed, but is not the default email client. A Microsoft Outlook client is installed, but is not configured correctly. The PST file is corrupt. The PST file is read-only (PST files must allow read and write access). The MAPI call fails. The bit editions of Microsoft Outlook do not match the bit editions of the KeyView software. For example, if 32-bit KeyView is used, 32-bit Outlook must be installed. If 64-bit KeyView is used, 64-bit Outlook must be installed.
KVError_PasswordRequired	To open the file, you must provide credentials. This error might be returned when a call to fpOpenFile() returns NULL.
KVError_InvalidArgs	The input argument or structure is invalid. This error is generated by the File Extraction APIs.
KVError_ReaderUsageDenied	The current license key does not enable the document reader required to filter the file. This error might be returned when a call to fpOpenFile() returns NULL. Some document readers are considered advanced features and are licensed separately from the KeyView SDK (for example, the PST and MBX readers). Contact your OpenText sales representative to get an updated license key.
KVError_OopBadConfig	Information in the kvxconfig.ini file is incomplete and cannot be used to filter the XML file.
KVError_OopBrokenPipe	Data was not transferred between the parent and child processes during out-of-process filtering because either the parent or child failed.
KVError_OopPipeOEF	Data was not transferred between the parent and child processes during out-of-process filtering because the parent process was shut down.
KVError_IPCTimeOut	Either the parent or child process is waiting for a reply or request during out-of-process filtering.
KVError_InvalidOopDriverSignature	A client sent a request to an out-of-process server, but the context driver does not exist on the server.
KVError_InvalidOopServiceSignature	A client sent a request to a File Extraction service that does not exist. If this error is generated on the call to fpClose(), you can ignore it.
KVError_ZeroFile	The input file is empty or zero bytes.
KVError_CompressionNotSupported	The file or subfile is compressed with an unsupported compression method.
KVError_NoTemplates
KVError_NoMainTemplate
KVError_InvalidTemplate
KVError_TemplateError
KVError_IsADirectory
KVError_RMSDecryptionFailed	KeyView was not able to access the protected contents of an RMS file.
KVError_InvalidLicense	The license used to initialize KeyView is not valid for this operation.
KVError_Last

Discussion

• When error reporting is enhanced in future releases, new error messages might be added to this enumerator type. When you use this type, your code must ensure binary compatibility with future releases. See Programming Guidelines.
• To aid transition from earlier versions of KeyView, names beginning KVERR_ are aliases of the new KVError_ names.