L_AnnGetObjectFromTag

Show in webframe

#include "l_bitmap.h"

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

HANNOBJECT hContainer;	/* handle to the container object */
L_UINT uFlags;	/* flags that determine which objects to process */
L_UINT32 uTag;	/* unsigned 32-bit integer used as the object's tag */
pHANNOBJECT phTagObject;	/* handle to the associated annotation object */

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

Parameter	Description
hContainer	Handle to the container object.
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.
uTag	The unsigned 32-bit integer used as the object's tag.
phTagObject	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.

Returns

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

Comments

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

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_AnnGetTag, L_AnnSetTag
Topics:	Annotation Functions: Object Information
	Implementing an Automated Annotation Program
	Implementing a Non-automated Annotation Program
	Obtaining Annotation Object Information

Example

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)
{
   UNREFERENCED_PARAMETER(pUserData);
   L_INT nRet;

   nRet = L_AnnSetTag(hObject, TagCount, 0);
   if (nRet == SUCCESS)
   {
      ++TagCount;
      MessageBox(NULL, TEXT("Tag set."), TEXT(""), MB_OK);
   }
   else
      MessageBox(NULL, TEXT("Tag not set."), TEXT(""), MB_OK);

   return SUCCESS;
}

 L_INT AnnGetObjectFromTagExample(HANNOBJECT hContainer,HANNOBJECT TagObject)
{
   L_INT nRet;
   /* This function finds the objetc with the specified tag. */
   L_UINT32    TagNo = 2;
 
   nRet = L_AnnSetTag(TagObject,TagNo, 0);

   nRet = L_AnnGetObjectFromTag(hContainer, ANNFLAG_RECURSE | ANNFLAG_NOTCONTAINER, TagNo, &TagObject);
   if(nRet != SUCCESS)
      return nRet;
   if (TagObject != NULL)
      MessageBox(NULL, TEXT("Object retrieved."), TEXT(""), MB_OK);
   else
      MessageBox(NULL, TEXT("Object not found."), TEXT(""), MB_OK);
   return SUCCESS ;
}