L_Jp2FreeBoxes

#include "l_bitmap.h"

L_LTJP2_API L_INT EXT_FUNCTION L_Jp2FreeBoxes(hJp2, eBox, pBox, uNumOfBoxes)

L_HJP2 hJp2;

/* JPEG 2000 engine handle */

eJP2BOXTYPE eBox;

/* boxes type */

L_VOID * pBox;

/* pointer to an array of boxes */

L_UINT uNumOfBoxes;

/* number of boxes */

Frees boxes that have been allocated by L_Jp2XXX functions such as: L_Jp2GetBoxes and L_Jp2ReadBox.

Parameter

Description

hJp2

JPEG 2000 engine handle that was created by the L_Jp2Create function.

eBox

The type of the boxes to be freed.

pBox

Pointer to an array of boxes to be freed.

uNumOfBoxes

Number of boxes. This field specifies the size of pBoxes.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

L_Jp2FreeBoxes frees boxes that have been allocated by any L_Jp2XXX function such as L_Jp2GetBoxes and L_Jp2ReadBox.

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.

Platforms

Win32, x64.

See Also

Functions:

L_Jp2ReadBox, L_Jp2GetBoxes

Topics:

Programming with JPEG 2000 Features
Raster Image Functions: Working with JPEG 2000

Example

For an example, refer to L_Jp2ReadBox.