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

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.