fpFree()

Frees the resources associated with a KVMetadataList structure.

Syntax

void pascal  fpFree(const struct KVMetadataList* const pMetadata);

Arguments

pMetadata A pointer to a KVMetadataList that you obtained by calling fpGetSubFileMetadataList(). This must be the same KVMetadataList pointer that you are calling fpFree() on.

Discussion

Once the KVMetadataList pointer has been freed, it is no longer valid, and should be set to NULL. You must not call any function on a KVMetadataList pointer that has been freed.

You may call fpFree() before all metadata elements have been retrieved by calling fpGetNext().

Once the KVMetadataList pointer has been freed, any KVMetadataElements obtained by calling fpGetNext() on that pointer are also invalid, and you must not access them.