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.
Parameters
Input |
Name |
Type |
Description |
panelHandle |
integer |
Specifier for a particular panel that is currently in memory. You obtain this
handle from LoadPanel, NewPanel, or DuplicatePanel. |
controlID |
integer |
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 NewCtrl or DuplicateCtrl. |
annotationIndex |
integer |
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 |
integer |
Return value indicating whether the function was successful. A negative number indicates that an error occurred.
Code |
Error Message String |
xx |
Success |
|