ISoftKbd::GetSoftKeyboardColors method

The ISoftKbd::GetSoftKeyboardColors method retrieves the soft keyboard color corresponding to the supplied color type.

Syntax

HRESULT GetSoftKeyboardColors(
  [in]  COLORTYPE colorType,
  [out] COLORREF  *lpColor
);

Parameters

colorType [in]

A value specifying the color type to retrieve for the soft keyboard. Possible values are defined for the COLORTYPE enumeration.

lpColor [out]

Pointer to a buffer in which this method retrieves a 32-bit COLORREF value specifying an RGB color.

Return value

This method can return one of these values.

Value Description
S_OK
The method was successful.
E_INVALIDARG
One of the parameters is invalid.

Requirements

Requirement Value
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
Softkbdc.h
IDL
Softkbd.idl
DLL
Softkbd.dll

See also

ISoftKbd

ISoftKbd::SetSoftKeyboardColors

COLORTYPE

COLORREF