L_AnnGetFontUnderline

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetFontUnderline(hObject, pfFontUnderline)

HANNOBJECT hObject;	/* handle to the annotation object */
L_BOOL *pfFontUnderline;	/* address of the variable to be updated */

Gets a value that indicates whether the font of the specified annotation object has an underline.

This function is available in the Document and Medical Imaging toolkits.

Parameter	Description
hObject	Handle to the annotation object.
pfFontUnderline	Address of the variable to be updated with the value indicating whether the font has an underline. Possible values are:
	Value	Meaning
	TRUE	The font has an underline.
	FALSE	The font does not have an underline.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Before calling this function, you must declare a variable of data type L_BOOL. Then, pass the address of the variable in the pfFontUnderline parameter. This function will update the variable with the annotation object's current value of the underline property.

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

Windows 2000 / XP/Vista.

See Also

Functions:	L_AnnSetFontName, L_AnnGetFontName, L_AnnGetFontNameLen, L_AnnSetFontSize, L_AnnGetFontSize, L_AnnSetFontUnderline, L_AnnSetFontStrikeThrough, L_AnnGetFontStrikeThrough, L_AnnSetFontItalic, L_AnnGetFontItalic, L_AnnSetFontBold, L_AnnGetFontBold
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

Example

For an example, refer to L_AnnSetFontUnderline.