Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Download Visual Studio Add-In

DeleteObject (gdi32)
 
.
Summary
The DeleteObject function deletes a logical pen, brush, font, bitmap, region, or palette, freeing all system resources associated with the object. After the object is deleted, the specified handle is no longer valid.

C# Signature:

/// <summary>Deletes a logical pen, brush, font, bitmap, region, or palette, freeing all system resources associated with the object. After the object is deleted, the specified handle is no longer valid.</summary>
/// <param name="hObject">A handle to a logical pen, brush, font, bitmap, region, or palette.</param>
/// <returns>
///   <para>If the function succeeds, the return value is nonzero.</para>
///   <para>If the specified handle is not valid or is currently selected into a DC, the return value is zero.</para>
/// </returns>
/// <remarks>
///   <para>Do not delete a drawing object (pen or brush) while it is still selected into a DC.</para>
///   <para>When a pattern brush is deleted, the bitmap associated with the brush is not deleted. The bitmap must be deleted independently.</para>
/// </remarks>
[DllImport("gdi32.dll", EntryPoint = "DeleteObject")]
[return: MarshalAs(UnmanagedType.Bool)]
public static extern bool DeleteObject([In] IntPtr hObject);
[DllImport("gdi32.dll")]
static extern bool DeleteObject(IntPtr hObject);

VB.Net Signature:

<DllImport("gdi32.dll")> _
Private Shared Function DeleteObject(hObject As IntPtr)  As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

VB Signature:

Public Declare Function DeleteObject Lib "gdi32.dll" _
          (ByVal hObject As Long) As Long

User-Defined Types:

None.

Notes:

None.

Tips & Tricks:

Call DeleteObject on a HBitmap object after using the GDI+ function:

[C#]
public static Bitmap FromHbitmap(
    IntPtr hbitmap
);

FromHbitmap transfers a copy of the image bytes into returned Bitmap so it is important to call DeleteObject on the HBitmap to prevent two copies of the image from existing in the system.

Sample Code:

Please see BitBlt

Alternative Managed API:

Do you know one? Please contribute it!

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions