KeyView 24.1

# fpGetOLESummaryInfoFile()

This function extracts document metadata from a file.

DEPRECATED: The `fpGetOLESummaryInfoFile()` function is deprecated in KeyView 23.2.0 and later. OpenText recommends that you create a `KVDocument` to represent each document, and access metadata by calling the function fpGetMetadataList().

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

## Syntax

    KVErrorCode pascal fpGetOLESummaryInfoFile(
        KVFilterSession     session,
        char               *szFile,
        KVSummaryInfoEx    *pSummaryInfo);

## Arguments

`session` | A KeyView Filter session that you initialized by calling fpInit().
`szFile` | The name of the input file.
`pSummaryInfo` | A pointer to the KVSummaryInfoEx structure. In the 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 KVSumInfoElemEx structure.

## Returns

The return value is an error code. See KVErrorCode.

## Discussion

- After the `pSummaryInfo` argument is successfully filled, and its data is no longer required, call fpFreeOLESummaryInfo() to free the memory allocated by this function.

- On Windows, `szFile` must be in the local Windows code page.

Copyright 2016-2023 Open Text
Version 24.1 | Last updated December 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 MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.1

Topic Title: fpGetOLESummaryInfoFile()