L_AnnGetScalarY

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetScalarY(hObject, pdScalarY)

Gets the vertical scaling factor that is applied to the annotation object. Typically, the scaling factors are applied to a root container so that the annotations will match the displayed image.

Parameters

HANNOBJECT hObject

Handle to the annotation object.

L_DOUBLE *pdScalarY

Address of the variable to be updated with the vertical scaling factor.

Returns

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

Comments

Offset values, which are set by the L_AnnSetOffsetX and L_AnnSetOffsetY functions, are applied after the scalar properties. For more information, refer to Low-Level Coordinate System for Annotations.

Before calling this function, you must declare a variable of data type L_DOUBLE. Then, pass the address of the variable in the pdScalarY parameter. This function will update the variable with the vertical scaling factor.

Required DLLs and Libraries

Platforms

Win32, x64.

Help Version 21.0.2021.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help