L_AnnGetRestrictToContainer

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetRestrictToContainer(hObject, pbRestrict)

HANNOBJECT hObject;	/* handle to the annotation object */
L_BOOL *pbRestrict;	/* pointer to a variable */

Determines whether the annotation object is restricted to the container.

This function is available in the Document and Medical Imaging toolkits.

Parameter	Description
hObject	Handle to the annotation object.
pbRestrict	Pointer to a boolean value that specifies whether to restrict the object to the container. Possible values are:
	Value	Meaning
	TRUE	Restrict the object to the container.
	FALSE	Do not restrict the object to the container.

Returns

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

Comments

Determines whether one or more annotation objects is restricted to the container.. If an object is restricted to the container, then no part of that object can be moved outside of the container using automation.

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.

Functions:	L_AnnDefine, L_AnnAddUserHandle, L_AnnAdjustPoint, L_AnnChangeUserHandle, L_AnnConvert, L_AnnDefine2, L_AnnDeleteUserHandle, L_AnnEnumerateHandles, L_AnnGetRotateAngle, L_AnnGetUserHandle, L_AnnGetUserHandles, L_AnnHitTest, L_AnnRestrictCursor, L_AnnSetRestrictToContainer, L_AnnSetAutoSnapCursor, L_AnnGetAutoSnapCursor
Topics:	Annotation Functions: Creating and Deleting Annotations
	Implementing Custom Annotations
	Implementing Annotations
	Implementing an Automated Annotation Program
	Implementing a Non-automated Annotation Program