GetGraphCursorIndex

int GetGraphCursorIndex (int panelHandle, int controlID, int cursorNumber, int *plotHandle, int *arrayIndex);

Purpose

Obtains the plot handle and array index of the point to which the cursor is currently attached.

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.
cursorNumber integer Identifies the cursor. cursorNumber can range from 1 to the number of defined cursors for the specified graph.

You can set the number of defined cursors when you edit the graph in the User Interface Editor or through SetCtrlAttribute.
Output
Name Type Description
plotHandle integer The ID of the plot to which the cursor is attached. If the cursor is not attached to a plot, the function returns –1.
arrayIndex integer The array index of the data point to which the cursor is attached. If the cursor is attached to a point plot, or if the cursor is not attached to a data point, the function returns –1.

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