KeyView 24.3

# fpFreeStruct()

This function frees the memory allocated by `fpGetMainFileInfo()`, `fpGetSubFileInfo()`, `fpGetSubFileMetadata()`, and `fpExtractSubFile()`.

## Syntax

    int (pascal *fpFreeStruct) (
        void      *pFile,
        void      *obj);

## Arguments

`pFile` | The identifier of the file. This is a file handle returned from fpOpenFile().
`obj` | A pointer to the result object returned by `fpGetMainFileInfo()`, `fpGetSubFileInfo()`, `fpGetSubFileMetaData`, or `fpExtractSubFile()`.

## Returns

- If the allocated memory is freed, the return value is `KVERR_Success`.
- Otherwise, the return value is an error code.

## Example

The example below frees the memory allocated by `fpGetSubFileInfo()`:

    if ( subFileInfo )
        {
            extractInterface->fpFreeStruct(pFile,subFileInfo);
            subFileInfo = NULL;
        }

Copyright 1997-2024 Open Text
Version 24.3 | Last updated June 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.3

Topic Title: fpFreeStruct()