In This Topic ▼

L_AnnGetOffsetY

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetOffsetY(hObject, pdOffsetY)

Gets the Y offset of the annotation object. Typically, this value is used to match the root container's offset to the offset of the associated bitmap's display rectangle.

Parameters

HANNOBJECT hObject

Handle to the annotation object.

L_DOUBLE *pdOffsetY

Address of the variable to be updated with the specified object's Y offset.

Returns

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

Comments

The offset values are applied after the scalar properties, which are set by the L_AnnSetScalarX and L_AnnSetScalarY functions. 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 pdOffsetY parameter. This function will update the variable with the value of the specified object's Y offset.

L_AnnGetOffsetY

Parameters

HANNOBJECT hObject

L_DOUBLE *pdOffsetY

Returns

Comments

Functions

Topics

Example