KeyView 24.4
KeyView Filter SDK C Programming Guide

# fpGetKvErrorCodeEx()

This function returns an error code defined in `KVErrorCode`. You can call this function to obtain additional information when fpGetDocInfoFile() or fpGetDocInfoStream() returns `false`. For information about the error codes that can be returned, see KVErrorCode.

DEPRECATED: The `fpGetKvErrorCodeEx()` function is deprecated in KeyView 23.2.0 and later.

This function is useful only if you use the deprecated functions fpGetDocInfoFile(), fpGetDocInfoStream(), and fpFilterConfig() which return `FALSE` to indicate an error, rather than returning an error code.

This function is still available for existing implementations, but it might be incompatible with new functionality and might be removed in future.

## Syntax

    KVErrorCodeEx pascal fpGetKvErrorCodeEx ( KVFilterSession session )

## Arguments

`session` | A KeyView Filter session that you initialized by calling fpInit().

## Returns

The return value is an error code from `KVErrorCode`.

## Discussion

You can access this function through the KV_GetFilterInterfaceEx() interface.

## Example

    if (!fpGetDocInfoFile(session, szFile, pADDocInfo))
    {
        int kvError = pFilterInterface->fpGetKvErrorCodeEx(session);
        printf("Error code %d\n", kvError);
        return;
    }

Copyright 1997-2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.4

Topic Title: fpGetKvErrorCodeEx()