GetActiveGraphCursor
int GetActiveGraphCursor (int panelHandle, int controlID, int *activeCursorNumber);
Purpose
Obtains the active cursor on the specified graph control.
Supported Controls
You can use GetActiveGraphCursor 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. |
| Output | ||
| Name | Type | Description |
| activeCursorNumber | int | The number of the active cursor. The value ranges from 1 to the number of defined cursors for the specified graph. You can set the number of cursors in the User Interface Editor or through SetCtrlAttribute. |
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
Example
Refer to userint\2yaxis.cws for an example of using the GetActiveGraphCursor function.