Microsoft Windows CE 3.0  

SetBkMode

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This function sets the background mix mode of the specified device context. The background mix mode is used with text, hatched brushes, and with non-solid pen styles.

int
SetBkMode( HDC
hdc
, int
iBkMode
);

Parameters

hdc
[in] Handle to the device context.
iBkMode
[in] Specifies the background mode. It is either of the following values.
Value Description
OPAQUE Background is filled with the current background color before the text, hatched brush, or pen is drawn.
TRANSPARENT Background remains untouched.

Return Values

If the function succeeds, the return value specifies the previous background mode.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The SetBkModefunction affects the line styles for lines drawn using a pen created by the CreatePenfunction. SetBkModedoes not affect lines drawn using a pen created by the ExtCreatePenfunction.

The iBkModeparameter can also be set to driver-specific values. GDI passes such values to the device driver and otherwise ignores them.

The iBKModeparameter is stored internally as a single byte.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 1.0 and later Wingdi.h   Mgbase.lib
Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

CreatePen, GetBkMode, GetLastError