L_AnnGetLineWidth

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetLineWidth(hObject, pdLineWidth)

HANNOBJECT hObject;

/* handle to the annotation object */

L_DOUBLE *pdLineWidth;

/* address of the variable to be updated */

Gets the current unscaled value of the line width of the specified annotation object.

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

Parameter

Description

hObject

Handle to the annotation object.

pdLineWidth

Address of the variable to be updated with the annotation object's current line width.

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_DOUBLE. Then, pass the address of the variable in the pdLineWidth parameter. This function will update the variable with the line width of the annotation object.

The line width is scaled using an average of the horizontal and vertical scaling factors of the container object. For more information, refer to Low-Level Coordinate System 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_AnnSetLineStyle, L_AnnGetLineStyle, 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_AnnSetLineWidth.