LJp2FileFormat::FreeBoxes

Show in webframe

#include "ltwrappr.h"

L_INT LJp2FileFormat::FreeBoxes(eBox, pBox, uNumOfBoxes)

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 LJp2FileFormat::XXX functions such as: LJp2FileFormat::GetBoxes and LJp2FileFormat::ReadBox.

Parameter	Description
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 pBox.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

LJp2FileFormat::FreeBoxes frees boxes that have been allocated by any LJp2FileFormat::XXX function such as LJp2FileFormat::GetBoxes and LJp2FileFormat::ReadBox.

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:	LJp2FileFormat::ReadBox, LJp2FileFormat::GetBoxes
Topics:	Implementing JPEG 2000 Features
	Raster Image Functions: Working with JPEG 2000
	Programming with JPX Features
	JPX File Comments
	Raster Image Functions: Working with JPX

Example

For an example, refer to LJp2FileFormat::ReadBox.