Bitmap.GetHbitmap Method (System.Drawing)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

Bitmap.GetHbitmap Method

Creates a GDI bitmap object from this Bitmap.

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

Syntax

Visual Basic (Declaration)

<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags := SecurityPermissionFlag.UnmanagedCode)> _
Public Function GetHbitmap As IntPtr

Visual Basic (Usage)

Dim instance As Bitmap
Dim returnValue As IntPtr

returnValue = instance.GetHbitmap()

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

Visual C++

[SecurityPermissionAttribute(SecurityAction::LinkDemand, Flags = SecurityPermissionFlag::UnmanagedCode)]
public:
IntPtr GetHbitmap()

JScript

public function GetHbitmap() : IntPtr

Return Value

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

Exceptions

Exception	Condition
ArgumentException	The height or width of the bitmap is greater than MaxValue.
Exception	The operation failed.

Remarks

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

Examples

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

Visual Basic

<System.Runtime.InteropServices.DllImportAttribute("gdi32.dll")> _
    Private Shared Function DeleteObject (ByVal hObject As IntPtr) As Boolean
    End Function



    Private Sub DemonstrateGetHbitmap()
        Dim bm As New Bitmap("Picture.jpg")
        Dim hBitmap As IntPtr
        hBitmap = bm.GetHbitmap()

        ' Do something with hBitmap.
        DeleteObject(hBitmap)
    End Sub

[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);
}

Visual C++

   [System::Runtime::InteropServices::DllImportAttribute("gdi32.dll")]
   static bool DeleteObject( IntPtr hObject );

private:
   void DemonstrateGetHbitmap()
   {
      Bitmap^ bm = gcnew Bitmap( "Picture.jpg" );
      IntPtr hBitmap = bm->GetHbitmap();

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

.NET Framework Security

SecurityPermission
for calling into unmanaged code. Related enumeration: UnmanagedCode

Platforms

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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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.

Version Information

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0

Reference

Bitmap Class

Bitmap Members

GetHbitmap Overload

System.Drawing Namespace