KeyView 23.4

# xxxGetSummaryInfo()

This function is required to extract document summary information.

## Syntax

    int  pascal _export xxxGetSummaryInfo(
        void                 *pCFContext,
        KVSummaryInfoEx      *pInfo,
        BOOL                  bFreeInfo)

## Arguments

`pCFContext` | A pointer to the global context structure for the custom reader.
`pInfo` | A pointer to a `KVSummaryInfoEx` structure defined in `kvtypes.h`.
`bFreeInfo` | A `BOOL` value indicating whether to free memory allocated for summary information.

## Returns

- Upon success, `KVERR_Success`.
- Upon error, a non-zero error code.

## Discussion

This function uses an instance of the global context structure that is different from the one used by all other reader interface functions.

This function can call the same functions used by `xxxFillBuffer()` or can be completely independent.

Copyright 2016-2023 Open Text
Version 23.4 | Last updated September 2023

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 swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL KeyView 23.4

Topic Title: xxxGetSummaryInfo()