LJp2FileFormat::GetBoxes
#include "ltwrappr.h"
L_INT LJp2FileFormat::GetBoxes(eBox, plBox, puNumOfBoxes)
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 |
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
LJp2FileFormat::GetBoxes 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 LJp2FileFormat::FreeBoxes.
Required DLLs and Libraries
LTJP2 For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
Win32, x64.
See Also
Functions: |
LJp2FileFormat::SetBoxes, LJp2FileFormat::FreeBoxes, LJp2FileFormat::ReadBox, LJp2FileFormat::AppendBoxes |
Topics: |
|
|
Example
For an example, refer to LJp2FileFormat::Save.