L_AnnGetBitmapDpiY

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetBitmapDpiY(hObject, pdDpiY)

HANNOBJECT hObject;

/* handle to the annotation automation object */

L_DOUBLE *pdDpiY;

/* address of the variable to be updated with the vertical DPI value */

Gets the vertical Bitmap DPI (dots per inch) that is used to translate the vertical distance for the Ruler object.

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

Parameter

Description

hObject

Handle to the annotation automation object.

pdDpiY

Address of the variable to be updated with the current vertical Bitmap DPI value.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The Bitmap DPI properties apply only to Automation and Ruler objects. Refer to Annotation Automation Object.

Before calling this function, you must declare a variable of data type L_DOUBLE. Then, pass the address of the variable in the pdDpiY parameter. This function will update the variable with the current Bitmap DPI setting.

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_AnnSetBitmapDpiY, L_AnnSetUnit, L_AnnGetUnit,

 

L_AnnGetDistance, L_AnnSetGaugeLength,

 

L_AnnGetGaugeLength, L_AnnGetTicMarkLength, L_AnnSetTicMarkLength, L_AnnGetDistance2, ANNSMARTDISTANCE

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

 

Annotation Features

 

Calibrating Annotation Ruler Objects

Example

For an example, refer to L_AnnSetBitmapDpiX.