KeyView 24.1

# fpGetNext()

Gets the next metadata element from a KVMetadataList. Call this function to iterate through the elements, beginning with the first. KeyView does not guarantee to iterate through metadata elements in any particular order.

## Syntax

    KVErrorCode(pascal* fpGetNext)(
        const struct tag_KVMetadataList* const pMetadata,
        const KVMetadataElement** const ppMetadataElement);

## Arguments

`pMetadata` | A pointer to a KVMetadataList that you obtained by calling fpGetMetadataList() or fpGetSubFileMetadataList(). This must be the same `KVMetadataList` pointer that you are calling `fpGetNext()` on.
`ppMetadataElement` | A pointer to a const KVMetadataElement pointer. On success, this will point to a KVMetadataElement containing the next metadata element in the list, or be set to NULL if the end of the list has been reached.

## Returns

The return value is an error code.

## Discussion

After iterating through all of the elements in the list, `ppMetadataElement` will point to a pointer whose value is NULL.

The KVMetadataElement does not need to be freed, but is only valid while the KVMetadataList has not been freed. Once the KVMetadataList has been freed, all elements associated with it are invalid, and you should not access any of their members.

Copyright 2016-2023 Open Text
Version 24.1 | Last updated December 2023

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.1

Topic Title: fpGetNext()