File Content Extraction 26.3
Filter SDK Java 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() or fpOpenFileFromFilterSession().
`args` | A KVGetSubFileMetadataListArg structure, which specifies how to retrieve the subfile metadata.
`ppMetadataList` | A pointer to a KVMetadataList*. On success, `fpGetSubFileMetadataList()` sets this pointer to the address of a new KVMetadataList that contains the function pointers for accessing metadata elements.

## Returns

The return value is an error code.

## Lifetime and Memory Management

You must free the KVMetadataList pointer by using its fpFree() function. Free this pointer only when `fpGetSubFileMetadadataList()` returns `KVError_Success`. You must free this pointer before you call fpCloseFile().

## Discussion

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

Copyright 1997-2026 Open Text
Version 26.3 | Last updated July 2026

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: File Content Extraction 26.3

Topic Title: fpGetSubFileMetadataList()