BaseCommonDecoderRead Method (String, Int32, ProgressEventHandler)

Read a given frame from file using this decoder.

Namespace: Atalasoft.Imaging.Codec
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.5.0.5.0.230 (.NET 4.6.2, x86)

Syntax

public virtual AtalaImage Read(
	string filePath,
	int frameIndex,
	ProgressEventHandler progress
)

Public Overridable Function Read ( 
	filePath As String,
	frameIndex As Integer,
	progress As ProgressEventHandler
) As AtalaImage

filePath: Type: SystemString
Location of a file in a computer's file system structure.
frameIndex: Type: SystemInt32
The zero based frame index.
progress: Type: Atalasoft.ImagingProgressEventHandler
The progress delegate. Can be set to null (Nothing in Visual Basic).

Type: AtalaImage
An AtalaImage containing the decoded image.

Exceptions

Exception	Condition
ArgumentException	filePath is null or empty.
ArgumentOutOfRangeException	frameIndex is not in range [0, frameCount] (See GetFrameCount(String) for details.).
CommonDecoderException	file decoding error. incorrect file format.

Exception

Condition

ArgumentException

filePath is null or empty.

ArgumentOutOfRangeException

frameIndex is not in range [0, frameCount] (See GetFrameCount(String) for details.).

file decoding error.

incorrect file format.

BaseCommonDecoderAddLanguageSpecificTextSet("LSTEF86BED8_0?cpp=::|nu=.");Read Method (String, Int32, ProgressEventHandler)