GetBox Method

Gets a box of the specified type for the engine.

Syntax

Visual Basic
C#
Objective-C
Java
C++

public Jpeg2000SingleBox GetBox( 
   Jpeg2000FileFormat format,
   Jpeg2000BoxType boxType
)

'Declaration
 
Public Function GetBox( _
   ByVal format As Jpeg2000FileFormat, _
   ByVal boxType As Jpeg2000BoxType _
) As Jpeg2000SingleBox

'Usage
 
Dim instance As Jpeg2000Engine
Dim format As Jpeg2000FileFormat
Dim boxType As Jpeg2000BoxType
Dim value As Jpeg2000SingleBox
 
value = instance.GetBox(format, boxType)

public:
Jpeg2000SingleBox^ GetBox( 
   Jpeg2000FileFormat format,
   Jpeg2000BoxType boxType
)

Parameters

format: Jpeg2000FileFormat specifies the JPEG 2000 engine.
boxType: Type of box being obtained.

Return Value

Jpeg2000SingleBox object containing the box data for the specified boxType.

Remarks

This method is used to get the following types of boxes:

Example

For an example, refer to Jpeg2000Engine.Save(RasterCodecs, string, RasterImage, Jpeg2000FileFormat, int, int) example.

Requirements

Target Platforms

Reference

Jpeg2000Engine Class
Jpeg2000Engine Members
AppendBox
AppendBoxes
ReadBox
SetBoxes
Compression Using LEAD and JPEG Formats
File Formats - JPEG And LEAD Compressed
Bitmaps In Memory And In Files
JPEG2000 File Comments
JPEG And LEAD File Comments
Programming with JPEG 2000 Features
JPEG 2000 Boxes