L_AnnSetActiveState

Summary

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

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetActiveState(hObject, uState)

Parameters

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.

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 a complete sample code, refer to the \Examples\Annotation\C\Annotate demo.

L_AnnSetActiveState

Summary

Syntax

Parameters

HANNOBJECT hObject

L_UINT uState

Returns

Comments

Required DLLs and Libraries

Platforms

See Also

Functions

Topics

Example