BaseCommonDecoderGetImageInfo Method (String, Int32) |
Retrieve information from a file about specified frame.
Namespace:
Atalasoft.Imaging.Codec
Assembly:
Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.5.0.5.0.230 (.NET 4.6.2, x86)
Syntaxpublic virtual ImageInfo GetImageInfo(
string filePath,
int frameIndex
)
Public Overridable Function GetImageInfo (
filePath As String,
frameIndex As Integer
) As ImageInfo
Parameters
- filePath
- Type: SystemString
File location in a computer's file system structure. - frameIndex
- Type: SystemInt32
The zero based frame index.
Return Value
Type:
ImageInfo An
ImageInfo object containing information about the specified frame such as size, pixel format etc.
Exceptions| Exception | Condition |
|---|
| ArgumentException | filePath is null or empty. |
| ArgumentOutOfRangeException | frameIndex is not in range [0, frameCount], (see GetFrameCount(String) for details). |
| CommonDecoderException | file data decoding error. |
See Also