KeyView 24.4
KeyView XML Export SDK C Programming Guide

# fpGetSummaryInfo()

This function extracts all metadata from the input stream. See Extract Metadata for more information.

## Syntax

    BOOL pascal _export fpGetSummaryInfo(
        void                *pContext,
        KVInputStream       *pInput,
        KVSummaryInfoEx     *pSummary,
        BOOL                 bFree );

## Arguments

`pContext` | A pointer to a KeyView Export session that you initialized by calling fpInit().
`pInput` | A pointer to the developer-assigned instance of `KVInputStream`. The `KVInputStream` structure points to the input stream that contains the source for the conversion. See KVInputStream.
`pSummary` | A pointer to the developer-assigned instance of `KVSummaryInfoEx`. In this structure, `nElem` provides a count of the number of metadata elements, and `pElem` points to the first element of the array of individual elements as defined by the structure `KVSumInfoElemEx`. See KVSummaryInfoEx.
`bFree` | A flag to free or fill the memory allocated to the document metadata.

## Returns

- If the call is successful, the return value is `TRUE`. When the document does not contain metadata, but the document reader can extract metadata from the specified format, this function returns `TRUE` with `nElem` set to `0`.

- If this call is unsuccessful, the return value is `FALSE`. This function returns `FALSE` when the document reader does not support metadata extraction for the specified format, or there is an error in extraction. The section Document Readers lists the file formats for which metadata can be determined.

## Discussion

- For metadata to be extracted by Export, metadata must be defined in the source document, and the document reader must be able to extract metadata for the file format. Document Readers lists the file formats for which metadata can be determined. Export does not generate metadata automatically from the document contents.

- This function runs in-process or out-of-process. See Convert Files Out-of-Process.

- You can call this function at any time after the call to `KVXMLInit()`.

- When converting out-of-process, this function must be called after the call to `KVXMLStartOOPSession()` and before the call to `KVXMLEndOOPSession()`. See KVXMLStartOOPSession() and KVXMLEndOOPSession().

- Call this function with `bFree` set to `FALSE` to return an array of `KVSummaryInfoEx` structures, each containing an element of available document metadata.

- After processing the information in the structure, call this function with `bFree` set to `TRUE` to free the memory allocated to the document metadata.

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: fpGetSummaryInfo()