L_AnnGetUnitLen

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetUnitLen(hObject, puLen)

HANNOBJECT hObject;

/* handle to the annotation automation object */

L_SIZE_T *puLen;

/* address of the variable to be updated with the length of the unit abbreviation string */

Gets the size of the buffer required to hold pUnitAbbrev in L_AnnGetUnit.

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

Parameter

Description

hObject

Handle to the annotation automation object.

puLen

Address of the variable to be updated with the length of the unit abbreviation string.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Call this function before calling L_AnnGetUnit if you want to get the exact size required to hold the Unit Abbreviation string.

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_AnnSetBitmapDpiX, L_AnnGetBitmapDpiX, L_AnnGetBitmapDpiY, L_AnnSetBitmapDpiY, L_AnnSetUnit, L_AnnGetUnit, L_AnnGetDistance, L_AnnSetGaugeLength, L_AnnGetGaugeLength, L_AnnGetTicMarkLength, L_AnnSetTicMarkLength, L_AnnGetDistance2, ANNSMARTDISTANCE, L_AnnCalibrateRuler, L_AnnCalibrateRulerSuccessive

Topics:

Annotation Functions: Working with the Toolbar

 

Implementing Annotations

 

Automated User Interface for Annotations

 

Implementing an Automated Annotation Program

 

Obtaining Annotation Object Information

 

Using Rulers in Annotation Objects

Example

For an example, refer to L_AnnSetUnit.