In This Topic ▼

ReadBox(string,Jpeg2000BoxType,int) Method

Summary

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

Syntax

C++

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

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

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