ITextFont::GetBackColor method (tom.h)
Gets the text background (highlight) color.
Syntax
HRESULT GetBackColor(
long *pValue
);
Parameters
pValue
Type: long*
The text background color. It can be one of the following values.
| Value | Meaning |
|---|---|
| A COLORREF value | The high-order byte is zero, and the three low-order bytes specify an RGB color. |
| A value returned by PALETTEINDEX | The high-order byte is 1, and the LOWORD specifies the index of a logical-color palette entry. |
| tomAutocolor (-9999997) | Indicates the range uses the default system background color. |
Return value
Type: HRESULT
If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.
| Return code | Description |
|---|---|
|
Invalid argument. |
|
The font object is attached to a range that has been deleted. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | tom.h |
| DLL | Msftedit.dll |
See also
Conceptual
Other Resources
Reference