ClearLegend
int ClearLegend (int panelHandle, int controlID);
Purpose
Hides all items in the graph or strip chart legend.
Calling this function is equivalent to disabling the ATTR_PLOT_LG_VISIBLE attribute for each plot in the graph or disabling the ATTR_TRACE_LG_VISIBLE attribute for each trace in the strip chart.
Supported Controls
You can use ClearLegend with the following 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. |
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 7.0 and later