SetGraphCursorIndex

int SetGraphCursorIndex (int panelHandle, int controlID, int cursorNumber, int plotHandle, int arrayIndex);

Purpose

Attaches a cursor to a particular data point that you specify by a plot handle and array index.

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.
plotHandle integer The handle of the plot on which to attach the cursor. Cursors cannot be attached to plots generated by the following functions:

PlotText
PlotOval
PlotRectangle
PlotArc
PlotLine
PlotBitmap
PlotIntensity
arrayIndex integer The array index of the data point on which to attach the cursor.

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