fpGetMetadataList()

Gets the metadata from a document. You can use this function to access all available metadata including document properties, OLE summary information, and XMP metadata.

If the file is a container, you can access metadata for its subfiles by using the Extract API. See the function fpGetSubFileMetadataList().

Syntax

KVErrorCode (pascal* fpGetMetadataList)(
    KVDocument pDocument,
    const KVMetadataList** const ppMetadataList);

Arguments

pDocument

A KVDocument that you created with fpOpenDocumentFromFile() or fpOpenDocumentFromStream().

ppMetadataList A pointer to a const KVMetadataList pointer. On success, this will contain the functions for accessing metadata elements, which must be freed with its fpFree function.

Returns

The return value is an error code.

Discussion

  • This function runs in process or out of process. See The Filter Process Model.
  • You must free the KVMetadataList pointer using its fpFree() function.