LJp2FileFormat::FreeComposite

#include "ltwrappr.h"

L_INT LJp2FileFormat::FreeComposite(pComposite)

pL_JP2_JPXCOMPOSITE pComposite;

/* pointer to a composite structure */

Frees and invalidates composite pointers that have been allocated by engine functions such as LJp2FileFormat::ReadComposite, LJp2FileFormat::ReadFrames, LJp2FileFormat::ReadCompositeMemory, and LJp2FileFormat::ReadFramesMemory. This function does not free the bitmaps inside the structures; you must free the bitmaps by using the LBitmapBase::Free function.

Parameter

Description

pComposite

Pointer to a composite structure to be freed.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

LJp2FileFormat::FreeComposite frees and invalidates composite pointers that have been allocated by engine functions such as LJp2FileFormat::ReadComposite, LJp2FileFormat::ReadFrames, LJp2FileFormat::ReadCompositeMemory, and LJp2FileFormat::ReadFramesMemory. This function does not free the bitmaps inside the structures; You must free the bitmaps by using the LBitmapBase::Free function.

Required DLLs and Libraries

LTJP2
LFJ2K
LTIMGEFX

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

LJp2FileFormat::ReadComposite, LJp2FileFormat::ReadFrames, LJp2FileFormat::ReadCompositeMemory, LJp2FileFormat::ReadFramesMemory

Topics:

Implementing JPEG 2000 Plug in Features

 

Raster Image Functions: Working with JPEG 2000

Example

For an example, refer to LJp2FileFormat::ReadFrames.