LAnnContainer::GetObjectFromTag

#include "ltwrappr.h"

virtual L_INT LAnnContainer::GetObjectFromTag(uTag, phTagObject, uFlags=ANNFLAG_RECURSE | ANNFLAG_NOTCONTAINER)

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

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

Parameter	Description
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.
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 LAnnContainer::GetSelectItems and LAnnotation::SetSelected 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.

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 LAnnotation::GetTag and LAnnotation::SetTag.

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:	LAnnotation::GetTag, LAnnotation::SetTag
Topics:	Annotation Functions: Object Information

Example

//This example uses the following member variables:

// LAnnotationWindow m_AnnotationWindow

// m_AnnotationWindow should be created and initialized prior to the example

L_INT LAnnAutomation_GetObjectFromTagExample(HWND hWnd)
{
   ANNRECT annContainerRect = {0,0,200,200};
   LAnnContainer AnnContainer(hWnd, &annContainerRect, TRUE);
   LAnnButton AnnButton;
   HANNOBJECT TagObject;
   ANNRECT annRect = {50,50,60,60};
   AnnButton.SetRect(&annRect);
   AnnButton.SetVisible(TRUE);
   AnnButton.SetTag(2);
   AnnContainer.Insert(AnnButton);
   L_INT nRet = AnnContainer.GetObjectFromTag(2,&TagObject);
   if (nRet==SUCCESS)
      AfxMessageBox(TEXT("Object found"));
   return SUCCESS;
}