KeyView 23.2

# fpGetXmpInfo()

This function extracts XMP metadata in stream mode.

DEPRECATED: The `fpGetXmpInfo()` 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 fpGetXmpInfo(
        KVFilterSession   session,
        KVInputStream    *pInput,
        KVXmpInfo        *pXmpInfo,
        DWORD             dwXmpOptions );

## Arguments

`session` | A KeyView Filter session that you initialized by calling fpInit().
`pInput` | A pointer to the input stream.
`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

The return value is an error code. See KVErrorCode.

## Discussion

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

- This function runs in process or out of process. See The Filter Process Model.

- For some formats, XMP extraction is supported only on certain platforms. See XMP extraction - additional formats in the platform differences section.

Copyright 2016-2023 Open Text
Version 23.2 | Last updated March 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.2

Topic Title: fpGetXmpInfo()