FreeImage.OpenMultiBitmapEx Method (String, FREE_IMAGE_FORMAT, FREE_IMAGE_LOAD_FLAGS, Boolean, Boolean, Boolean)

FreeImage.NET

previous page next page

FreeImage.NET Class Library Reference

FreeImageOpenMultiBitmapEx Method (String, FREE_IMAGE_FORMAT, FREE_IMAGE_LOAD_FLAGS, Boolean, Boolean, Boolean)

Loads a FreeImage multi-paged bitmap. In case the loading format is FIF_UNKNOWN the files real format is being analysed. If no plugin can read the file, format remains FIF_UNKNOWN and 0 is returned. Load flags can be provided by the flags parameter.

Namespace: FreeImageAPI
Assembly: FreeImageNET (in FreeImageNET.dll) Version: 3.17.0.4 (3.17.0)

Syntax

Copy

public static FIMULTIBITMAP OpenMultiBitmapEx(
	string filename,
	ref FREE_IMAGE_FORMAT format,
	FREE_IMAGE_LOAD_FLAGS flags,
	bool create_new,
	bool read_only,
	bool keep_cache_in_memory
)

Parameters

filename: Type: SystemString
The complete name of the file to load.
format: Type: FreeImageAPIFREE_IMAGE_FORMAT
Format of the image. If the format is unknown use FIF_UNKNOWN. In case a suitable format was found by LoadEx it will be returned in format.
flags: Type: FreeImageAPIFREE_IMAGE_LOAD_FLAGS
Flags to enable or disable plugin-features.
create_new: Type: SystemBoolean
When true a new bitmap is created.
read_only: Type: SystemBoolean
When true the bitmap will be loaded read only.
keep_cache_in_memory: Type: SystemBoolean
When true performance is increased at the cost of memory.

Return Value

Type: FIMULTIBITMAP
Handle to a FreeImage multi-paged bitmap.

Exceptions

Exception	Condition
FileNotFoundException	filename does not exists while opening.

Reference

FreeImage Class

OpenMultiBitmapEx Overload

FreeImageAPI Namespace

Contact/Feedback: FreeImage.NET Homepage
Help improve this Documentation: Join the Project

previous page start next page