ReadBox(String,Jpeg2000BoxType,Int32) Method

Reads a boxType of box at the boxIndex index from the specified JPEG 2000 file.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++/CLI

public Jpeg2000Box ReadBox( 
   string fileName,
   Jpeg2000BoxType boxType,
   int boxIndex
)

'Declaration
 
Public Overloads Function ReadBox( _
   ByVal fileName As String, _
   ByVal boxType As Jpeg2000BoxType, _
   ByVal boxIndex As Integer _
) As Jpeg2000Box

'Usage
 
Dim instance As Jpeg2000Engine
Dim fileName As String
Dim boxType As Jpeg2000BoxType
Dim boxIndex As Integer
Dim value As Jpeg2000Box
 
value = instance.ReadBox(fileName, boxType, boxIndex)

public Jpeg2000Box ReadBox( 
   string fileName,
   Jpeg2000BoxType boxType,
   int boxIndex
)

 function Leadtools.Jpeg2000.Jpeg2000Engine.ReadBox(String,Jpeg2000BoxType,Int32)( 
   fileName ,
   boxType ,
   boxIndex 
)

public:
Jpeg2000Box^ ReadBox( 
   String^ fileName,
   Jpeg2000BoxType boxType,
   int boxIndex
)

Parameters

fileName: System.String containing the name of the JPEG 2000 file.
boxType: Box type to be read.
boxIndex: 0-based box index specifying the box to be read.

Return Value

Jpeg2000Box object containing the box data.

Remarks

All of the engine boxes will be reset (both those that have been loaded and any that have not been loaded). Only those boxes that have been found in the file during loading are updated.

Example

For an example, refer to Leadtools.Jpeg2000.Jpeg2000Engine.SaveComposite(RasterCodecs codecs, string fileName, List<CompositeJpxImages> compositeImages, Jpeg2000FileFormat format, int bitsPerPixel, int qualityFactor) example.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

Jpeg2000Engine Class
Jpeg2000Engine Members
Overload List
AppendBox
AppendBoxes
ReadBox(Stream,Jpeg2000BoxType,Int32)
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