L_AnnRemove

Summary

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

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnRemove(hObject)

Parameters

HANNOBJECT hObject

Handle to the annotation object.

Returns

Value Meaning
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

Platforms

Win32, x64.

See Also

Functions

Topics

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, L_FALSE); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   return SUCCESS; 
} 

Help Version 22.0.2023.7.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.