L_AnnGetVisible
#include "l_bitmap.h"
L_INT EXT_FUNCTION L_AnnGetVisible(hObject, pfVisible)
HANNOBJECT hObject; |
/* handle to the annotation object */ |
/* address of the variable to be updated */ |
Gets a value that indicates whether the specified annotation object is visible. This function is available in the Document/Medical Toolkits.
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
Windows 95 / 98 / Me, Windows 2000 / XP.
See Also
Functions: |
|
Topics: |
|
|
|
|
|
|
|
|
Example
/* This example uses a callback function (called by L_AnnEnumerate) to count the number
of invisible objects */
L_INT L_EXPORT EXT_CALLBACK TestAnnCallback (HANNOBJECT hObject, L_INT L_FAR * 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;
}