GetNumLegendItems

int GetNumLegendItems (int panelHandle, int controlID, int *numItems);

Purpose

Returns the number of visible items in the graph legend.

The value returned by this function is equivalent to the number of plots in the graph which have the ATTR_PLOT_LG_VISIBLE attribute enabled.

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.
Output
Name Type Description
numItems integer (passed by reference) The number of visible items in the graph legend.

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