L_AnnGetLineStyle

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetLineStyle(hObject, puLineStyle)

HANNOBJECT hObject;

/* handle to the annotation object */

L_UINT *puLineStyle;

/* address of the variable to be updated */

Gets the line style of the specified annotation object. This function is available in the Document/Medical Toolkits.

Parameter

Description

hObject

Handle to the annotation object.

puLineStyle

Address of the variable to be updated with the annotation object's current line style. Possible line style values are:

 

Value

Meaning

 

ANNLINE_SOLID

[0] Solid line

 

ANNLINE_DASH

[1] Dashed line

 

ANNLINE_DOT

[2] Dotted line

 

ANNLINE_DASHDOT

[3] Dash dot line

 

ANNLINE_DASHDOTDOT

[4] Dash dot dot line

 

ANNLINE_NULL

[5] No line

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_UINT. Then, pass the address of the variable in the puLineStyle parameter. This function will update the variable with the annotation object's line style constant.

Note: Windows displays all lines greater than 1 pixel as solid.

To see the possible line styles, refer to Illustration of Line Styles for Annotations.

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_AnnSetLineWidth, L_AnnGetLineWidth, L_AnnSetLineStyle, L_AnnGetLineFixedWidth, L_AnnSetLineFixedWidth

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_AnnSetLineStyle.