GetNumLegendItems
int GetNumLegendItems (int panelHandle, int controlID, int *numberOfItems);
Purpose
Returns the number of visible items in the graph or strip chart legend.
The value returned by this function is equivalent to the following:
- The number of plots in the graph that have the ATTR_PLOT_LG_VISIBLE attribute enabled
- The number of traces in the strip chart that have the ATTR_TRACE_LG_VISIBLE attribute enabled
Supported Controls
You can use GetNumLegendItems 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. |
| Output | ||
| Name | Type | Description |
| numberOfItems | int | The number of visible items in the graph or strip chart legend. |
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