L_AnnGetOffsetY

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetOffsetY(hObject, pdOffsetY)

HANNOBJECT hObject;	/* handle to the annotation object */
L_DOUBLE *pdOffsetY;	/* address of the variable to be updated */

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. This function is available in the Document/Medical Toolkits.

Parameter	Description
hObject	Handle to the annotation object.
pdOffsetY	Address of the variable to be updated with the specified object's Y offset.

Returns

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.

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 2000 / XP/Vista.

See Also

Functions:	L_AnnSetScalarX, L_AnnSetScalarY, L_AnnGetScalarX, L_AnnGetScalarY, L_AnnSetOffsetX, L_AnnSetOffsetY, L_AnnGetOffsetX, L_AnnGetFixed, L_AnnSetFixed, L_AnnPushFixedState, L_AnnPopFixedState, L_AnnIsFixedInRect
Topics:	Annotation Functions: Getting and Setting Geometric Properties
	Low-Level Coordinate System for Annotations
	Implementing an Automated Annotation Program
	Implementing a Non-automated Annotation Program
	Fixed Annotations
	Minimizing Flicker with Double Buffering
	Obtaining Annotation Object Information

Example

For an example, refer to L_AnnSetOffsetX.