Retrieves a handle to the object that has the specified tag.


#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetObjectFromTag(hContainer, uFlags, uTag, phTagObject)



Handle to the container object.

L_UINT uFlags

Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values:

Value Meaning
0 Process only the specified object.
ANNFLAG_SELECTED [0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the L_AnnGetSelected and L_AnnSetSelected functions.
ANNFLAG_NOTTHIS [0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.
ANNFLAG_RECURSE [0x0008] Process objects within a container, and within any subcontainers, down to any level.
ANNFLAG_NOTCONTAINER [0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.
ANNFLAG_NOINVALIDATE [0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

L_UINT32 uTag

The unsigned 32-bit integer used as the object's tag.


Address of a variable to be updated with the handle to the annotation object that has the tag specified in uTag. If an object with the specified tag is not found, the variable will be updated with NULL.


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


For more information on getting and setting tags, refer to L_AnnGetTag and L_AnnSetTag.

This function applies to multiple and selected objects based on values of the uFlags parameter.

Required DLLs and Libraries


Win32, x64.

See Also




static L_INT TagCount = 0; 
L_VOID AnnEnumerateExample(HANNOBJECT hContainer, ANNENUMCALLBACK annTagCallback) 
   /* This function sets the tags for the selected objects. */ 
   L_AnnEnumerate(hContainer, annTagCallback, NULL, ANNFLAG_SELECTED | ANNFLAG_NOTTHIS, 0); 
L_INT EXT_CALLBACK annTagCallback(HANNOBJECT hObject, L_VOID* pUserData) 
   L_INT nRet; 
   nRet = L_AnnSetTag(hObject, TagCount, 0); 
   if (nRet == SUCCESS) 
      _tprintf(_T("%s"), TEXT("Tag set.")); 
      _tprintf(_T("%s"), TEXT("Tag not set.")); 
   return nRet; 
/* This function finds the object with the specified tag. */ 
L_INT AnnGetObjectFromTagExample(HANNOBJECT hContainer, HANNOBJECT TagObject) 
   L_INT    nRet; 
   L_UINT32 TagNo = 2; 
   nRet = L_AnnSetTag(TagObject, TagNo, 0); 
   if (nRet != SUCCESS) 
      return nRet; 
   nRet = L_AnnGetObjectFromTag(hContainer, ANNFLAG_RECURSE | ANNFLAG_NOTCONTAINER, TagNo, &TagObject); 
   if (nRet != SUCCESS) 
      return nRet; 
   if (TagObject != NULL) 
      _tprintf(_T("%s"), TEXT("Object retrieved.")); 
      _tprintf(_T("%s"), TEXT("Object not found.")); 
   return SUCCESS; 
Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 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.