Bitmap.GetHbitmap Method

Definition

Namespace:

System.Drawing

Assembly:

System.Drawing.Common.dll

Creates a GDI bitmap object from a GDI+ Bitmap.

Overloads

GetHbitmap()	Creates a GDI bitmap object from this Bitmap.
GetHbitmap(Color)	Creates a GDI bitmap object from this Bitmap.

GetHbitmap()

Source:

Bitmap.cs

Creates a GDI bitmap object from this Bitmap.

C#

public IntPtr GetHbitmap();

Returns

IntPtr

A handle to the GDI bitmap object that this method creates.

Exceptions

ArgumentException

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

Exception

The operation failed.

Examples

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

C#

[System.Runtime.InteropServices.DllImport("gdi32.dll")]
public static extern bool DeleteObject(IntPtr hObject);

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

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

Remarks

You are responsible for calling the GDI DeleteObject method to free the memory used by the GDI bitmap object. For more information about GDI bitmaps, see Bitmaps in the Windows GDI documentation.

GetHbitmap(Color)

Source:

Bitmap.cs

Creates a GDI bitmap object from this Bitmap.

C#

public IntPtr GetHbitmap(System.Drawing.Color background);

Parameters

background

Color

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

Returns

IntPtr

A handle to the GDI bitmap object that this method creates.

Exceptions

ArgumentException

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

Exception

The operation failed.

Examples

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

C#

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

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

Remarks

You are responsible for calling the GDI DeleteObject method to free the memory used by the GDI bitmap object. For more information about GDI bitmaps, see Bitmaps in the Windows GDI documentation.