L_AnnGetForeColor

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetForeColor(hObject, pcrFore)

HANNOBJECT hObject;

/* handle to the annotation object */

COLORREF *pcrFore;

/* address of the variable to be updated */

Gets the current value of the specified annotation object's foreground color.

Parameter

Description

hObject

Handle to the annotation object.

pcrFore

Address of the COLORREF variable to be updated with the annotation object's current foreground color.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To see how the foreground color relates to the fill modes, refer to Illustration of Fill Options for Annotations.

Before calling this function, you must declare a variable of data type COLORREF. Then, pass the address of the variable in the pcrFore parameter. This function will update the variable with the annotation object's current foreground color.

Required DLLs and Libraries

LTANN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:

L_AnnSetForeColor, L_AnnSetBackColor, L_AnnGetBackColor, L_AnnGetFillMode, L_AnnSetFillMode, L_AnnGetOptions, L_AnnSetOptions

Topics:

Annotation Functions: Object Properties

 

Annotation Objects - Default Values

 

Annotation Objects - Automated Features

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

 

Obtaining Annotation Object Information

 

Using Color Values in LEADTOOLS

Example

For an example, refer to L_AnnSetForeColor.