This documentation is archived and is not being maintained.

Bitmap.GetHbitmap Method (Color)

Creates a GDI bitmap object from this Bitmap.

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

[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public IntPtr GetHbitmap(
	Color background
)

Parameters

background
Type: System.Drawing.Color

A Color structure that specifies the background color. This parameter is ignored if the bitmap is totally opaque.

Return Value

Type: System.IntPtr
A handle to the GDI bitmap object that this method creates.

ExceptionCondition
ArgumentException

The height or width of the bitmap is greater than MaxValue.

Exception

The operation failed.

You are responsible for calling the GDI DeleteObject method to free the memory used by the GDI bitmap object.

The following code example demonstrates how to use the GetHbitmap.method.


private void DemonstrateGetHbitmapWithColor() 
{
    Bitmap bm = new Bitmap("Picture.jpg");
    IntPtr hBitmap = bm.GetHbitmap(Color.Blue);

    // Do something with hBitmap.
    DeleteObject(hBitmap);
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

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