GetActiveLegendItem
- Updated2023-02-21
- 1 minute(s) read
int GetActiveLegendItem (int panelHandle, int controlID, int *item);
Purpose
Returns the index of the active trace item on the strip chart legend or the handle of the active plot on the graph legend.
The legend has an active item when the interactive legend context menu is active.
Supported Controls
You can use GetActiveLegendItem 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 |
| item | int | If the control is a strip chart, this is the index of the active trace item. If the control is a graph, this is the handle of the active plot. Returns zero if there is no active legend item. |
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 2012 and later