L_AnnGetNodes (original) (raw)
Summary
Gets information on how to display the nodes of the annotation object in design mode.
Syntax
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetNodes(hObject, pbShowNodes, puGapNodes)
Parameters
HANNOBJECT hObject
Handle of the annotation object.
L_BOOL *pbShowNodes
Address of the variable to be updated with a value that indicates whether to show the nodes. Pass NULL if you do not wish to retrieve this information. Possible values are:
Value | Meaning |
---|---|
TRUE | Show the nodes. |
FALSE | Do not show the nodes. |
L_UINT *puGapNodes
Address of the variable to be updated with a value that represents the number of nodes to skip before displaying another node (Pass NULL if you do not wish to retrieve this information). Possible values are:
Value | Meaning |
---|---|
0 | Show every node. |
1 | Show a node, skip a node, show a node |
... | |
9 | Show a node, skip the next nine, |
Returns
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
Comments
This function is valid for the following annotation objects:
- Curve
- Closed Curve
- Freehand
- Freehand Hotspot
- Polygon
- Polyline
In addition, the Automation object stores node settings along with the other object default settings.
Note: The last node is always shown. Therefore, using a large value for puGapNodes
will probably result in only the first and last nodes being shown.
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
Topics
- Annotation Functions: Object Properties
- 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_AnnSetNodes.
LEADTOOLS Raster Imaging C API Help