L_Jp2GetBoxes

#include "l_bitmap.h"

L_LTJP2_API L_INT EXT_FUNCTION L_Jp2GetBoxes(hJp2, eBox, plBox, puNumOfBoxes)

L_HJP2 hJp2;

/* JPEG 2000 engine handle */

eJP2BOXTYPE eBox;

/* Boxes type */

L_VOID **plBox;

/* pointer to a pointer */

L_UINT * puNumOfBoxes;

/* pointer to a variable to be updated */

Gets all engine boxes of the specified type.

Parameter

Description

hJp2

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

eBox

Box type.

plBox

Pointer to a pointer to be updated with an array of boxes of the specified type.

puNumOfBoxes

Address of a variable to be updated with the number of boxes found inside the engine, which is also the array size.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

L_Jp2GetBoxes gets JPEG 2000 engines boxes that are have been loaded while loading a JPEG 2000 file or that are going to be saved within a JPEG 2000 file. You must free the allocated boxes array by calling the L_Jp2FreeBoxes.

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_Jp2SetBoxes, L_Jp2FreeBoxes, L_Jp2ReadBox, L_Jp2AppendBoxes

Topics:

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

Example

For an example, refer to L_Jp2Save.