LAnnotation::SetActiveState

#include "ltwrappr.h"

virtual L_INT LAnnotation::SetActiveState(uState=ANNACTIVE_ENABLED)

L_UINT uState;

/* flag that indicates whether to enable the object */

Sets the Activation State of the annotation object.

Parameter

Description

uState

Flag that indicates whether to enable or disable the object.  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

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

AudioClip

Button

HotSpot

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.

See Also

Functions:

Class Members

Topics:

Annotation Functions: Object Properties

 

Implementing Annotations

Example

For an example, refer to LAnnotation::GetActiveState.