Click or drag to resize

BaseCommonDecoderRead Method (Stream, Int32, ProgressEventHandler)

Read a given frame in an encoded image 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 override AtalaImage Read(
	Stream stream,
	int frameIndex,
	ProgressEventHandler progress
)

Parameters

stream
Type: System.IOStream
The input Stream.
frameIndex
Type: SystemInt32
The zero based frame index.
progress
Type: Atalasoft.ImagingProgressEventHandler
The progress delegate. Can be set to null (Nothing in Visual Basic).

Return Value

Type: AtalaImage
An AtalaImage containing the decoded image.
Exceptions
ExceptionCondition
ArgumentException

stream is null.

ArgumentOutOfRangeException

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

CommonDecoderException

file decoding error.

incorrect file format.

See Also