L_AnnSetActiveState

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetActiveState(hObject, uState)

Sets the activation state of an annotation object. If an annotation object is active, it will respond to activation events.

Parameters

HANNOBJECT hObject

Handle to the annotation object.

L_UINT uState

The constant that indicates whether the object is enabled or disabled. Possible values are:

Value	Meaning
ANNACTIVE_DISABLED	[0] The object will not respond to activation events.
ANNACTIVE_ENABLED	[1] The object will respond to activation events.

Returns

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

Comments

The following types of objects, respond to activation events:

Automation object
Audio clip
Button
HotSpot
Freehand HotSpot
Push pin

For descriptions of the various types of objects and their properties, refer to Types of Annotations.

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.

Functions

L_AnnGetActiveState
L_AnnGetUserMode
L_AnnSetUserMode

Topics

Annotation Functions: Object Properties
Implementing Annotations
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 an example of how the tag of an activated object is used, refer to the L_AnnGetTag function. For complete sample code, refer to the ANNOTATE example.