Loads a FreeImage multi-paged bitmap from a stream and returns the FreeImage memory stream used as temporary buffer. The bitmap can not be modified by calling AppendPage(FIMULTIBITMAP, FIBITMAP), InsertPage(FIMULTIBITMAP, Int32, FIBITMAP), MovePage(FIMULTIBITMAP, Int32, Int32) or DeletePage(FIMULTIBITMAP, Int32).

Namespace:  FreeImageAPI
Assembly:  FreeImageNET (in FreeImageNET.dll)

Syntax

C#
public static FIMULTIBITMAP LoadMultiBitmapFromStream(
	Stream stream,
	FREE_IMAGE_FORMAT format,
	FREE_IMAGE_LOAD_FLAGS flags,
	out FIMEMORY memory
)
Visual Basic (Declaration)
Public Shared Function LoadMultiBitmapFromStream ( _
	stream As Stream, _
	format As FREE_IMAGE_FORMAT, _
	flags As FREE_IMAGE_LOAD_FLAGS, _
	<OutAttribute> ByRef memory As FIMEMORY _
) As FIMULTIBITMAP
Visual C++
public:
static FIMULTIBITMAP LoadMultiBitmapFromStream(
	Stream^ stream, 
	FREE_IMAGE_FORMAT format, 
	FREE_IMAGE_LOAD_FLAGS flags, 
	[OutAttribute] FIMEMORY% memory
)

Parameters

stream
Type: System.IO..::.Stream
The stream to read from.
format
Type: FreeImageAPI..::.FREE_IMAGE_FORMAT
Format of the image.
flags
Type: FreeImageAPI..::.FREE_IMAGE_LOAD_FLAGS
Flags to enable or disable plugin-features.
memory
Type: FreeImageAPI..::.FIMEMORY %
The temporary memory buffer used to load the bitmap.

Return Value

Handle to a FreeImage multi-paged bitmap.

Exceptions

ExceptionCondition
System..::.ArgumentNullException stream is null.
System..::.ArgumentException stream can not read.

Version Information

FreeImage.NET

Supported in: 3.11.0, 3.12.0, 3.13.0, 3.13.1

See Also