L_AnnGetVisible

Show in webframe

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetVisible(hObject, pfVisible)

HANNOBJECT hObject;	/* handle to the annotation object */
L_BOOL *pfVisible;	/* address of the variable to be updated */

Gets a value that indicates whether the specified annotation object is visible.

Parameter	Description
hObject	Handle to the annotation object.
pfVisible	Address of the variable to be updated with a value indicating whether the annotation object is visible. Possible values are:
	Value	Meaning
	TRUE	The object is visible.
	FALSE	The object is not visible.

Returns

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

Comments

For a container object, the visible property determines whether objects in the container can be displayed. For other types of objects, the visible property determines whether the individual object can be displayed.

Before calling this function, you must declare a variable of data type L_BOOL. Then, pass the address of the variable in the pfVisible parameter. This function will update the variable with the annotation object's current value of the visible property.

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:	L_AnnSetVisible
Topics:	Annotation Functions: Object Properties
	Annotation Objects - Default Values
	Implementing an Automated Annotation Program
	Implementing a Non-automated Annotation Program
	Obtaining Annotation Object Information

Example

This example uses a callback function (called by L_AnnEnumerate) to count the number of invisible objects.

L_INT EXT_CALLBACK AnnGetVisibleExample(HANNOBJECT hObject,
                                        L_INT*     pUserData)
{
   L_BOOL   IsVisible;     /* Indicates whether the object is visible */
   L_INT    ObjectCount;   /* The number of objects */

   /* Initialize the object count */
   ObjectCount = (L_INT) *pUserData;
   /* Get the current value of the visible property */
   L_AnnGetVisible (hObject, &IsVisible);
   /* Update the counter if the object is not visible */
   if (IsVisible == FALSE)
   {
      ++ObjectCount;
   }
   /* Update the caller's variable */
   *pUserData = ObjectCount;
   return SUCCESS;
}