KeyView 24.4
KeyView XML Export SDK C Programming Guide

# fpGetSubFileMetadataList()

Containers can store metadata about their subfiles that is independent of the metadata stored within those subfiles. This function allows you to retrieve the metadata stored within the container about a particular subfile.

## Syntax

    KVErrorCode pascal fpGetSubFileMetadataList(
        void* const pFile,
        KVGetSubFileMetadataListArg args,
        const KVMetadataList** const ppMetadataList);

## Arguments

`pfile` | The identifier of the container file - a file handle that you obtained by calling fpOpenFile().
`args` | A pointer to a KVGetSubFileMetadataListArg structure, which specifies how to retrieve the subfile metadata.
`ppMetadataList` | A pointer to a const KVMetadataList pointer. On success, this will contain the functions for accessing metadata elements, and must be freed with its fpFree() function.

## Returns

The return value is an error code.

## Discussion

Before retrieving any subfile metadata, you must get the main file information by calling fpGetMainFileInfo().

This function runs in-process or out-of-process. See Convert Files Out-of-Process.

You must free the KVMetadataList pointer using its fpFree() function.

Copyright 1997-2024 Open Text
Version 24.4 | Last updated September 2024

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: IDOL KeyView 24.4

Topic Title: fpGetSubFileMetadataList()