Image.FromStream Method (Stream, Boolean) (System.Drawing)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

Image.FromStream Method (Stream, Boolean)

Creates an Image from the specified data stream, optionally using embedded color management information in that stream.

Namespace: System.Drawing
Assembly: System.Drawing (in System.Drawing.dll)

Syntax

Visual Basic

Public Shared Function FromStream ( _
	stream As Stream, _
	useEmbeddedColorManagement As Boolean _
) As Image

public static Image FromStream(
	Stream stream,
	bool useEmbeddedColorManagement
)

Visual C++

public:
static Image^ FromStream(
	Stream^ stream, 
	bool useEmbeddedColorManagement
)

static member FromStream : 
        stream:Stream * 
        useEmbeddedColorManagement:bool -> Image

Parameters

stream: Type: System.IO.Stream
A Stream that contains the data for this Image.

useEmbeddedColorManagement: Type: System.Boolean
true to use color management information embedded in the data stream; otherwise, false.

Return Value

Type: System.Drawing.Image
The Image this method creates.

Exceptions

Exception	Condition
ArgumentException	The stream does not have a valid image format -or- stream is null.

Exception

Condition

ArgumentException

The stream does not have a valid image format

-or-

stream is null.

Remarks

You must keep the stream open for the lifetime of the Image.

The useEmbeddedColorManagement parameter specifies whether the new Image applies color correction according to color management information that is embedded in the data stream. Embedded information can include International Color Consortium (ICC) profiles, gamma values, and chromaticity information.

The stream is reset to zero if this method is called successively with the same stream.

Note
The Image class does not support alpha transparency in bitmaps. To enable alpha transparency, use PNG images with 32 bits per pixel.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

Image Class

FromStream Overload

System.Drawing Namespace