Sets the horizontal Bitmap DPI (dots per inch) value that is used to translate the horizontal distance for the Ruler object.


#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetBitmapDpiX(hObject, dDpiX, uFlags)



Handle to the annotation automation object.


The horizontal DPI value to set. Valid values are greater than or equal to 1.

If you pass 0 or a positive value less than 1, the value will default to 150. If you pass a negative value, the function will return an error.

L_UINT uFlags

Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values:

Value Meaning
0 Process only the specified object.
ANNFLAG_SELECTED [0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the L_AnnGetSelected and L_AnnSetSelected functions.
ANNFLAG_NOTTHIS [0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.
ANNFLAG_RECURSE [0x0008] Process objects within a container, and within any subcontainers, down to any level.
ANNFLAG_NOTCONTAINER [0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.
ANNFLAG_NOINVALIDATE [0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.


Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.


This function applies to multiple and selected objects based on the value of the uFlags parameter.

Only Automation and Ruler objects are affected.. Refer to Annotation Automation Object.

You should set this value to the bitmaps XResolution. Call this function every time you load objects or paste them from the clipboard. Otherwise, the distances shown by the ruler objects will not be accurate.

Required DLLs and Libraries


Win32, x64.

See Also




L_INT AnnSetBitmapDpiXExample(pBITMAPHANDLE LeadBitmap, HANNOBJECT hContainer) 
   L_INT    nRet; 
   L_DOUBLE xRes; 
   L_DOUBLE yRes; 
   /* get the bitmap x and y res from the object */ 
   nRet = L_AnnGetBitmapDpiX(hContainer, &xRes); 
   if (nRet != SUCCESS) 
      return nRet; 
   nRet = L_AnnGetBitmapDpiY(hContainer, &yRes); 
   if (nRet != SUCCESS) 
      return nRet; 
   /* set all selected items to have the same dpi for ruler tool as the bitmap */ 
   if (xRes != (L_DOUBLE)LeadBitmap->XResolution) 
      nRet = L_AnnSetBitmapDpiX(hContainer, (L_DOUBLE)LeadBitmap->XResolution, ANNFLAG_RECURSE | ANNFLAG_SELECTED); 
      if (nRet != SUCCESS) 
         return nRet; 
   if (yRes != (L_DOUBLE)LeadBitmap->YResolution) 
      nRet = L_AnnSetBitmapDpiY(hContainer, (L_DOUBLE)LeadBitmap->YResolution, ANNFLAG_RECURSE | ANNFLAG_SELECTED); 
      if (nRet != SUCCESS) 
         return nRet; 
   return SUCCESS; 
Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.