L_AnnSetTag

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetTag(hObject, uTag, uFlags)

HANNOBJECT hObject;

/* handle to the annotation object */

L_UINT32 uTag;

/* unsigned 32-bit integer to use as the object's tag */

L_UINT uFlags;

/* flags that determine which objects to process */

Sets the tag of one or more annotation objects. You can use this tag to identify objects when they are saved in a file.

This function is available in the Document and Medical Imaging toolkits.

Parameter

Description

hObject

Handle to the annotation object.

uTag

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

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.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

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

Windows 2000 / XP/Vista.

See Also

Functions:

L_AnnGetTag

Topics:

Annotation Functions: Object Properties

 

Annotation Objects - Default Values

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

 

Altering Annotation Object Settings

Example

For an example, refer to the TestCreateButtonAnn procedure in Using Non automated Annotations in Run Mode. For complete sample code, refer to the ANNOTATE example.