DeleteObject function

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.

Syntax

C++


BOOL DeleteObject(
  _In_ HGDIOBJ hObject
);

Parameters

hObject [in]: A handle to a logical pen, brush, font, bitmap, region, or palette.

Return value

If the function succeeds, the return value is nonzero.

If the specified handle is not valid or is currently selected into a DC, the return value is zero.

Remarks

Do not delete a drawing object (pen or brush) while it is still selected into a DC.

When a pattern brush is deleted, the bitmap associated with the brush is not deleted. The bitmap must be deleted independently.

Examples

For an example, see Creating Colored Pens and Brushes.

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Wingdi.h (include Windows.h)
Library	Gdi32.lib
DLL	Gdi32.dll
Unicode and ANSI names	DeleteObjectW (Unicode)