L_AnnGetSelected (original) (raw)
Summary
Gets a value that indicates whether the specified annotation object is selected.
Syntax
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetSelected(hObject, pfSelected)
Parameters
HANNOBJECT hObject
Handle to the annotation object.
L_BOOL *pfSelected
Address of the variable to be updated with the value indicating whether the annotation object is selected. Possible values are:
Value | Meaning |
---|---|
TRUE | The object is selected. |
FALSE | The object is not selected. |
Returns
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
Comments
Before calling this function, you must declare a variable of data type L_BOOL. Then, pass the address of the variable in the pfSelected
parameter. This function will update the variable with the annotation object's current value of the selected property.
You can use the L_AnnSetXXX functions to set the properties of all objects that have the selected property set to TRUE.
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_AnnSelectRect
- L_AnnGetSelectRect
- L_AnnGetSelectCount
- L_AnnSelectPoint
- L_AnnGetType
- L_AnnSetSelected
- L_AnnGetSelectItems
- L_AnnGetROP2
- L_AnnSetROP2
- L_AnnShowLockedIcon
- L_AnnGetFillMode
- L_AnnSetFillMode
- L_AnnGetOptions
- L_AnnSetOptions
Topics
- Annotation Functions: Using Window Coordinates to Select Objects
- Annotation Functions: Object Information
- Annotation Objects - Default Values
- Annotation Objects - Automated Features
- Implementing an Automated Annotation Program
- Implementing a Non-automated Annotation Program
- Obtaining Annotation Object Information
Example
For an example, refer to L_AnnSetSelected.
LEADTOOLS Raster Imaging C API Help