Admin Production ni-theme
Current Publication

GetGraphCursor

LabWindows/CVI

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.

Supported Controls

You can use GetGraphCursor with graph 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.
cursorNumber int 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 Returns the x-coordinate of the cursor position.
y double Returns the y-coordinate of the cursor position.

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 3.0 and later

Examples

Refer to the following examples that use the GetGraphCursor function:

  • apps\daqmthread\daqMT.cws

    Open example
  • apps\mandelbrot\mandel.cws

    Open example
  • userint\2yaxis.cws

    Open example
  • userint\graphcursors.cws

    Open example