Help Center

CTextDocument2.GetEffectColormethod

Retrieves the color used for special text attributes.

Windowsmethoddoc-orphan
No implementation located. This member is documented, but the source scan found no matching declaration. It is likely declared in a header this scan does not resolve, or provided by a macro.

Syntax

FUNCTION GetEffectColor (BYVAL Index AS LONG) AS ULONG

Parameters

NameDescription
IndexThe index of the color to retrieve. It can be one of the following values.

Return value

If the method succeeds, GetLastResult returns NOERROR. Otherwise, it returns an HRESULT error code.

Description

Retrieves the color used for special text attributes.

Remarks

The first 16 index values are for special underline colors. If an index between 1 and 16 hasn't been defined by a call to the GetEffectColor method, GetEffectColor returns the corresponding Microsoft Word default color.

Reference