LAnnotation::GetActiveState

#include "ltwrappr.h"

virtual L_UINT LAnnotation::GetActiveState()

Gets the Activation State of the specified object.

Returns

The object's activation state constant. 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.

Comments

The following types of objects respond to activation events:

Automation object

AudioClip

Button

HotSpot

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

L_INT LAnnotation_GetActiveStateExample(LAnnotation& LeadAnn)
{
   L_INT nRet;
   L_UINT   uActiveState ;
   ANNRECT  AnnRect ;
   
   uActiveState = LeadAnn.GetActiveState() ;
   if (uActiveState != ANNACTIVE_ENABLED)
   {
      nRet = LeadAnn.SetActiveState(ANNACTIVE_ENABLED) ;
      if(nRet != SUCCESS)
         return nRet;
   }
   nRet = LeadAnn.GetRect(&AnnRect); 
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}