ITextFont::GetForeColor method

Gets the foreground, or text, color.

Syntax


HRESULT GetForeColor(
  long *pValue
);

Parameters

pValue

Type: long*

The foreground color. It can be one of the following values.

ValueMeaning
A COLORREF valueThe 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 that the range uses the default system foreground 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 codeDescription
E_INVALIDARG

Invalid argument.

CO_E_RELEASED

The font object is attached to a range that has been deleted.

 

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

Reference
ITextFont
SetForeColor
Conceptual
Text Object Model
Other Resources
COLORREF
PALETTEINDEX

 

 

Community Additions

ADD
Show:
© 2014 Microsoft