L_AnnGetActiveState

Show in webframe

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetActiveState(hObject, puState)

HANNOBJECT hObject;	/* handle to the annotation object */
L_UINT *puState;	/* address of the variable to be updated */

Gets the activation state of the specified object.

Parameter	Description
hObject	Handle to the annotation object.
puState	Address of the variable to be updated with the object's activation state constant. Possible activation state values are:
	Value	Meaning
	ANNACTIVE_DISABLED	[0] The object is disabled. It will not respond to activation events.
	ANNACTIVE_ENABLED	[1] The object is enabled. It 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
Audio clip
Button
Hot spot
Freehand Hot spot
Push pin
Video

Before calling this function, you must declare a variable of data type L_UINT. Then, pass the address of the variable in the puState parameter. This function will update the variable with the annotation object's activation state constant.

Please note that Video objects can have an active state of ANNACTIVE_ENABLED only if the LEADTOOLS video DLL is present. ERROR_FEATURE_NOT_SUPPORTED is returned if the video DLL is missing.

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_AnnSetActiveState, L_AnnGetUserMode,
	L_AnnSetUserMode
Topics:	Annotation Functions: Object Properties
	Implementing Annotations
	Implementing an Automated Annotation Program
	Implementing a Non-automated Annotation Program
	Obtaining Annotation Object Information