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() or fpOpenFileFromFilterSession().
obj

A KVMainFileInfo, KVSubFileInfo, KVSubFileMetaData or KVSubFileExtractInfo obtained through a call to fpGetMainFileInfo(), fpGetSubFileInfo(), fpGetSubFileMetaData(), fpExtractSubFile(), or fpGetExtractInfo().

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;
    }