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)

Syntax

C#
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
)
Visual Basic (Declaration)
Public Shared Function OpenMultiBitmapEx ( _
	filename As String, _
	ByRef format As FREE_IMAGE_FORMAT, _
	flags As FREE_IMAGE_LOAD_FLAGS, _
	create_new As Boolean, _
	read_only As Boolean, _
	keep_cache_in_memory As Boolean _
) As FIMULTIBITMAP
Visual C++
public:
static FIMULTIBITMAP OpenMultiBitmapEx(
	String^ filename, 
	FREE_IMAGE_FORMAT% format, 
	FREE_IMAGE_LOAD_FLAGS flags, 
	bool create_new, 
	bool read_only, 
	bool keep_cache_in_memory
)

Parameters

filename
Type: System..::.String
The complete name of the file to load.
format
Type: FreeImageAPI..::.FREE_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: FreeImageAPI..::.FREE_IMAGE_LOAD_FLAGS
Flags to enable or disable plugin-features.
create_new
Type: System..::.Boolean
When true a new bitmap is created.
read_only
Type: System..::.Boolean
When true the bitmap will be loaded read only.
keep_cache_in_memory
Type: System..::.Boolean
When true performance is increased at the cost of memory.

Return Value

Handle to a FreeImage multi-paged bitmap.

Exceptions

ExceptionCondition
System.IO..::.FileNotFoundException filename does not exists while opening.

Version Information

FreeImage.NET

Supported in: 3.11.0, 3.12.0, 3.13.0, 3.13.1

See Also