You are here: Start » FIL.NET » Function Reference » Image » Image IO » FIL.LoadImage

FIL.LoadImage

Loads a single image from a file.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void LoadImage
(
	string inFile,
	bool inLoadAlphaChannel,
	FilNet.Image outImage
)

Parameters

Name Type Range Default Description
inFilestringPath to a file.
inLoadAlphaChannelboolWhether to load the alpha channel (if exists) as an additional image channel.
outImageFilNet.ImageOutput image.

Description

The operation loads an image from a file in one of the standard image file formats. Currently the filter supports the following formats:

  • BMP (*.bmp),
  • JPEG (*.jpg, *jpeg),
  • PNG (*.png),
  • PNM (*.pbm, *.pgm, *.ppm, *.pnm),
  • TIFF (*.tif, *.tiff).

The format of the image file is recognized automatically based on the file header.

The resulting outImage will be three-channel image of UInt8 pixel type, or sometimes of UInt16 pixel type for 16-bit depth images of supported formats (PNG, TIFF).

Errors

List of possible exceptions:

Error type Description
DomainError Image is damaged or it is not a BMP, PNG, PNM, TIF or JPG file in LoadImage. File: File name
Unable to open an image. Image header format is unrecognized. Image format is unknown or image is damaged. Load image supports only BMP, PNG, PNM, JPG and TIFF formats.

See also