Leadtools.Jpeg2000 Requires Document/Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
ReadBox(String,Jpeg2000BoxType,Int32) Method
See Also 
Leadtools.Jpeg2000 Namespace > Jpeg2000Engine Class > ReadBox Method : ReadBox(String,Jpeg2000BoxType,Int32) Method



fileName
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.
Reads a box of type boxType at index boxIndex from the specified JPEG 2000 file.

Syntax

Visual Basic (Declaration) 
Public Overloads Function ReadBox( _
   ByVal fileName As String, _
   ByVal boxType As Jpeg2000BoxType, _
   ByVal boxIndex As Integer _
) As Jpeg2000Box
Visual Basic (Usage)Copy Code
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)
C# 
public Jpeg2000Box ReadBox( 
   string fileName,
   Jpeg2000BoxType boxType,
   int boxIndex
)
C++/CLI 
public:
Jpeg2000Box^ ReadBox( 
   String^ fileName,
   Jpeg2000BoxType boxType,
   int boxIndex
) 

Parameters

fileName
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.

Example

Remarks

All engine boxes will be reset and updated 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

See Also

Leadtools.Jpeg2000 requires a Document or Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features