IUIImage::GetBitmap method (uiribbon.h)

Retrieves a bitmap to display as an icon in the ribbon and context popup UI of the Windows Ribbon framework.

Syntax

HRESULT GetBitmap(
  [out] HBITMAP *bitmap
);

Parameters

[out] bitmap

Type: HBITMAP*

When this method returns, contains a pointer to the handle to the requested bitmap.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

IUIImage::GetBitmap is called on image property callback triggered by InvalidateUICommand.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header uiribbon.h
DLL Mshtml.dll

See also

IUIImage

IUIImageFromBitmap

Windows Ribbon Framework Samples