In This Topic ▼

ReadBox(Stream,Jpeg2000BoxType,int) Method

Summary

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

Syntax

C++

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

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

public: 
Jpeg2000Box^ ReadBox(  
   Stream^ stream, 
   Jpeg2000BoxType boxType, 
   int boxIndex 
)

Parameters

stream
A System.IO.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.

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, Stream stream, List<CompositeJpxImages> compositeImages, Jpeg2000FileFormat format, int bitsPerPixel, int qualityFactor) example.

Requirements

Target Platforms