ITfLangBarItemBitmap::DrawBitmap method

Syntax


HRESULT DrawBitmap(
  [in]   LONG bmWidth,
  [in]   LONG bmHeight,
  [in]   DWORD dwFlags,
  [out]  HBITMAP *phbmp,
  [out]  HBITMAP *phbmpMask
);

Parameters

bmWidth [in]

Contains the width, in pixels, of the bitmap item.

bmHeight [in]

Contains the height, in pixels, of the bitmap item.

dwFlags [in]

Not currently used.

phbmp [out]

Pointer to an HBITMAP value that receives the handle of the bitmap drawn for the bitmap item.

phbmpMask [out]

Pointer to an HBITMAP value that receives the handle of the mask bitmap. This is a monochrome bitmap that functions as a mask for phbmp. Each black pixel in this bitmap will cause the cooresponding pixel in phbmp to be displayed in its normal color. Every white pixel in this bitmap will cause the cooresponding pixel in phbmp to be displayed in the inverse of its normal color.

To display the bitmap without any color conversion, create a monochrome bitmap the same size as phbmp and set each pixel to black (RGB(0, 0, 0)).

Return value

This method can return one of these values.

ValueDescription
S_OK

The method was successful.

E_INVALIDARG

One or more parameters are invalid.

E_OUTOFMEMORY

A memory allocation failure occurred.

 

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Ctfutb.h

IDL

Ctfutb.idl

DLL

Msctf.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft