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

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.

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