File Content Extraction 25.4
Filter SDK C Programming Guide

# fpGetXmpInfoFile()

This function extracts XMP metadata from a file.

DEPRECATED: The `fpGetXmpInfoFile()` 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 fpGetXmpInfoFile(
        void            *pMainContext,
        char            *szInputFile,
        KVXmpInfo       *pXmpInfo,
        DWORD            dwXmpOptions );

## Arguments

`pMainContext` | A pointer to the `TPMainContext` structure, which is defined in `kvtypes.h`.
`szInputFile` | A pointer to the input file.
`pXmpInfo` | A pointer to the KVXmpInfo structure.
`dwXmpOptions` | Set this argument to `1` to return charset information, the raw XMP packet, and the path and value pairs of all XMP elements. Set this argument to `2` to return the raw XMP packet.

## 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 `pXmpInfo`, pass it to fpFreeXmpInfo() to free the memory allocated by this function. Call fpFreeXmpInfo() only when `fpGetXMPInfoFile()` returns `KVError_Success`

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

Copyright 1997-2025 Open Text
Version 25.4 | Last updated October 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.4

Topic Title: fpGetXmpInfoFile()