L_AnnGetShowFlags

#include "l_bitmap.h"

L_INT EXT_FUNCTION L_AnnGetShowFlags(hObject, puShowFlags)

HANNOBJECT hObject;

/* handle to the annotation object */

L_UINT L_FAR * puShowFlags;

/* address of the variable to be updated */

Gets a value that indicates how the rulers, cross-products, and protractors will be displayed. This function is available in the Document/Medical Toolkits.

Parameter

Description

hObject

Handle to the annotation object.

puShowFlags

Address of the variable to be updated with the value that indicates how the rulers, cross-products, and protractors will be shown. Possible values contained in puShowFlags are:

 

Value

Meaning

 

0

Do not display the ruler length or the ruler gauge or the tic marks. In this case, the ruler looks like a line.

 

ANNSHOW_LENGTH

Display the ruler length.

 

ANNSHOW_GAUGE

Display the ruler gauge.

 

ANNSHOW_TICMARKS

Display the tic marks.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function can only be used for the Ruler, Cross-Product, and Protractor objects. In addition, the Automation object stores show flag settings along with the other object default settings

For Protractor objects, the default value for uShowFlags is 0. For the Ruler, PolyRuler, and Cross-Product objects the default value for uShowFlags is ANNSHOW_LENGTH | ANNSHOW_TICMARKS.

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 95 / 98 / Me, Windows 2000 / XP.

See Also

Functions:

L_AnnSetShowFlags

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

 

Using Rulers in Annotation Objects

 

New Annotation Features of Version 14.5

 

Calibrating Annotation Ruler Objects

Example

For an example, refer to L_AnnSetShowFlags.