Bitmap::GetHBITMAP method

The Bitmap::GetHBITMAP method creates a Windows Graphics Device Interface (GDI) bitmap from this Bitmap object.

Syntax

Status GetHBITMAP(
  IN const Color & colorBackground,
  OUT HBITMAP      *hbmReturn
);

Parameters

colorBackground

Type: const Color

Reference to a Color object that specifies the background color. This parameter is ignored if the bitmap is totally opaque.

hbmReturn

Type: HBITMAP*

Pointer to an HBITMAP that receives a handle to the GDI bitmap.

Return Value

Type: Type: Status

If the method succeeds, it returns Ok, which is an element of the Status enumeration.

If the method fails, it returns one of the other elements of the Status enumeration.

Requirements

   
Minimum supported client Windows XP, Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header gdiplusheaders.h (include Gdiplus.h)
Library Gdiplus.lib
DLL Gdiplus.dll

See Also

Bitmap

Image

Images, Bitmaps, and Metafiles

Using Images, Bitmaps, and Metafiles