In This Topic ▼

L_AnnGetProtractorOptions

Summary

Gets the options for the specified Protractor object.

Syntax

#include "l_bitmap.h"

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

Parameters

HANNOBJECT hObject

Handle to the annotation object.

L_BOOL *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.

L_UINT *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".

L_SIZE_T *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.

L_TCHAR * 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.

L_UINT *puPrecision

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

L_DOUBLE *pdArcRadius

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

Returns

Value	Meaning
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.