Collapse All Expand All

L_AnnRemove

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnRemove(hObject)

HANNOBJECT hObject;

/* handle to the annotation object */

Removes the specified annotation object from its current container, leaving the object with no container.

Parameter	Description
hObject	Handle to the annotation object.

Returns

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

Comments

If you want the object to be inserted into another container, such as the main container of the display, you must use the L_AnnInsert function.

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

Win32, x64.

See Also

Functions:	L_AnnInsert, L_AnnGetContainer, L_AnnGetTopContainer, L_AnnEnumerate, L_AnnGetItem, L_AnnAddUserHandle, L_AnnAdjustPoint, L_AnnChangeUserHandle, L_AnnConvert, L_AnnDefine2, L_AnnDeleteUserHandle, L_AnnEnumerateHandles, L_AnnGetRestrictToContainer, L_AnnGetRotateAngle, L_AnnGetUserHandle, L_AnnGetUserHandles, L_AnnHitTest, L_AnnRestrictCursor, L_AnnSetRestrictToContainer
Topics:	Annotation Functions: Creating and Deleting Annotations
	Annotation Functions: Object Information
	Implementing Annotations
	Implementing an Automated Annotation Program
	Implementing a Non-automated Annotation Program
	Implementing Custom Annotations
	Displaying and Manipulating Annotation Objects

Example

This example removes an object from its container and inserts it into the root container.

 L_INT AnnRemoveExample(HANNOBJECT hAnnObject)
{
   L_INT nRet;
   HANNOBJECT RootContainer; /* Root container */

   /* Get the root container */
   nRet = L_AnnGetTopContainer(hAnnObject, &RootContainer);
   if(nRet != SUCCESS)
      return nRet;
   /* Remove the object from its current container */
   nRet = L_AnnRemove(hAnnObject);
   if(nRet != SUCCESS)
      return nRet;
   /* Insert the object into the root container */
   nRet = L_AnnInsert(RootContainer, hAnnObject, FALSE);
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}