Leadtools.Jpeg2000	Requires Document/Medical product license \| Send comments on this topic. \| Back to Introduction - All Topics \| Help Version 15.12.10
ReadBox(Stream,Jpeg2000BoxType,Int32) Method
See Also

Leadtools.Jpeg2000 Namespace > Jpeg2000Engine Class > ReadBox Method : ReadBox(Stream,Jpeg2000BoxType,Int32) Method

stream: A Stream containing the JPEG 2000 file data.

boxType: Box type to be read.

boxIndex: 0-based box index specifying the box to be read.

Reads a box of type boxType at index boxIndex from the specified JPEG 2000 data stream.

Syntax

Visual Basic (Declaration)
Overloads Public Function ReadBox( _ ByVal stream As Stream, _ ByVal boxType As Jpeg2000BoxType, _ ByVal boxIndex As Integer _ ) As Jpeg2000Box

Visual Basic (Usage)	Copy Code
`Dim instance As Jpeg2000Engine Dim stream As Stream Dim boxType As Jpeg2000BoxType Dim boxIndex As Integer Dim value As Jpeg2000Box value = instance.ReadBox(stream, boxType, boxIndex)`

C#
public Jpeg2000Box ReadBox( Stream stream, Jpeg2000BoxType boxType, int boxIndex )

Managed Extensions for C++
public: Jpeg2000Box* ReadBox( Stream* stream, Jpeg2000BoxType boxType, int boxIndex )

C++/CLI
public: Jpeg2000Box^ ReadBox( Stream^ stream, Jpeg2000BoxType boxType, int boxIndex )

Parameters

stream: A Stream containing the JPEG 2000 file data.
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.

Example

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

Remarks

All engine boxes will be reset and upadted with the new loaded box only

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family