GetGraphCursor

int GetGraphCursor (int panelHandle, int controlID, int cursorNumber, double *x, double *y);

Purpose

Obtains the current position of a specific graph cursor.

The position is relative to the current range of the x- and y-axes.

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
x double-precision Returns the x-coordinate of the cursor position.
y double-precision Returns the y-coordinate of the cursor position.

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