L_AnnGetDpiX

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetDpiX(hObject, pdDpiX)

HANNOBJECT hObject;

/* handle to the annotation automation object */

L_DOUBLE *pdDpiX;

/* address of the variable to be updated */

Gets the current horizontal DPI (dots per inch) value that is used to translate user input, such as font size, that is expressed in physical measurements.

Parameter

Description

hObject

Handle to the annotation automation object.

pdDpiX

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

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The DPI properties apply only to the annotation automation object. 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 pdDpiX parameter. This function will update the variable with the current 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

Win32, x64.

See Also

Functions:

L_AnnCreate, L_AnnSetAutoContainer, L_AnnGetAutoContainer, L_AnnSetDpiX, L_AnnSetDpiY, L_AnnGetDpiY, L_AnnSetTool, L_AnnGetTool, L_AnnGetUserMode, L_AnnSetUserMode, L_AnnSetUndoDepth, L_AnnUndo, 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

Example

This function gets the current dots per inch of the automation object.

 L_INT AnnGetDpiXExample(HANNOBJECT hAutoObject) /* Automation object */
{
   L_INT nRet;
   L_DOUBLE DPIx, DPIy;    /* Dots per inch, horizontal and vertical */
   L_TCHAR  szMessage[80]; /* Message buffer */

   /* Get the dots per inch */
   nRet = L_AnnGetDpiX(hAutoObject, &DPIx);
   if(nRet != SUCCESS)
      return nRet;
   nRet = L_AnnGetDpiY(hAutoObject, &DPIy);
   if(nRet != SUCCESS)
      return nRet;
   /* Display a message box with the result */
   wsprintf (szMessage, TEXT("%d horizontal, %d vertical"), (L_INT)DPIx, (L_INT)DPIy);
   MessageBox (NULL, szMessage, TEXT("Notice"), MB_OK);
   return SUCCESS;
}