File Content Extraction 25.3
Filter SDK C Programming Guide

# 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 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

- If the call is successful, the return value is `KVError_Success`.
- If the call is not successful, the return value is an error code that indicates the problem.

## Discussion

- When you no longer need `pSummaryInfo`, pass it to fpFreeOLESummaryInfo() to free the memory allocated by this function. Call fpFreeOLESummaryInfo() only when `fpGetOLESummaryInfoFile()` returns `KVError_Success`.

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

Copyright 1997-2025 Open Text
Version 25.3 | Last updated July 2025

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: File Content Extraction 25.3

Topic Title: fpGetOLESummaryInfoFile()