DeleteGraphAnnotation
int DeleteGraphAnnotation (int panelHandle, int controlID, int annotationIndex);
Purpose
Deletes the graph annotation at the specified 1-based index. If you pass –1 for annotationIndex, this function deletes all annotations for the specified graph.
Supported Controls
You can use DeleteGraphAnnotation with graph controls.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. |
| annotationIndex | int | The 1-based index of the graph annotation to delete. If you pass –1 for the index, this function deletes all annotations for the specified graph. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 8.0 and later
Example
Refer to userint\GraphAnnotations.cws for an example of using the DeleteGraphAnnotation function.