L_AnnGetProtractorOptions

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetProtractorOptions(hObject, pbAcute, puUnit, puAbbrevLen, pszAbbrev, puPrecision, pdArcRadius)

HANNOBJECT hObject;

/* handle to the annotation object */

L_BOOL *pbAcute;

/* address of the variable to be updated */

L_UINT *puUnit;

/* address of the variable to be updated */

L_SIZE_T *puAbbrevLen;

/* address of the variable to be updated */

L_TCHAR *pszAbbrev;

/* address of the variable to be updated */

L_UINT *puPrecision;

/* address of the variable to be updated */

L_DOUBLE *pdArcRadius;

/* address of the variable to be updated */

Gets the options for the specified Protractor object.

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

Parameter

Description

hObject

Handle to the annotation object.

pbAcute

Address of the variable to be updated with a value that indicates whether the inside angle or the outside angle of the protractor is being drawn. Possible values are:

 

Value

Meaning

 

TRUE

The inside (acute) angle of the protractor is being drawn.

 

FALSE

The outside (obtuse) angle of the protractor is being drawn.

 

Pass NULL if you do not wish to retrieve this information.

 

puUnit

Address of the variable to be updated with a value that indicates whether the units of the angle are degrees or radians. Pass NULL if you do not wish to retrieve this information. The updated values are:

 

Value

Meaning

 

ANNANGLE_DEGREES

The angle is measured in degrees. The default abbreviation for this unit is the degree sign.

 

ANNANGLE_RADIANS

The angle is measured in radians. The default abbreviation for this unit is "rad".

puUnit

Address of the variable to be updated with a value that indicates whether the units of the angle are degrees or radians. Pass NULL if you do not wish to retrieve this information.

puAbbrevLen

Address of the variable to be updated with the length of the abbreviation string that follows the angle. Pass NULL if you do not wish to retrieve this information.

pszAbbrev

Address of the character string to be updated with the abbreviation string that follows the angle. Pass NULL if you do not wish to retrieve this information.

puPrecision

Addresss of the variable to be updated with the number of digits after the decimal. ("." ) Valid values are 0 200.

pdArcRadius

Address of the variable to be updated with the length of the arc radius.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

You may wish to call this function once, with pszAbbrev set to NULL, and a pointer for puAbbrevLen. The variable pointed to by puAbbrevLen will contain the length of the abbreviation string. Allocate a buffer of this size and call this function again, passing the newly allocated buffer for pszAbbrev.

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_AnnSetProtractorOptions, L_AnnGetAngle

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