L_AnnGetScalarY
#include "l_bitmap.h"
L_INT EXT_FUNCTION L_AnnGetScalarY(hObject, pdScalarY)
HANNOBJECT hObject; |
/* handle to the annotation object */ |
/* address of the variable to be updated */ |
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. This function is available in the Document/Medical Toolkits.
Parameter |
Description |
hObject |
Handle to the annotation object. |
pdScalarY |
Address of the variable to be updated with the vertical scaling factor. |
Returns
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
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
Example
For an example, refer to L_AnnGetScalarX.