Admin Production ni-theme
Current Publication

SetCursorAttribute

LabWindows/CVI

SetCursorAttribute

int SetCursorAttribute (int panelHandle, int controlID, int cursorNumber, int cursorAttribute, int attributeValue);

Purpose

Sets one of the following graph cursor attributes:

ATTR_CURSOR_MODE
ATTR_CURSOR_POINT_STYLE
ATTR_CROSS_HAIR_STYLE
ATTR_CURSOR_COLOR
ATTR_CURSOR_XAXIS
ATTR_CURSOR_YAXIS

Supported Controls

You can use SetCursorAttribute 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.
cursorAttribute int The graph cursor attribute value to set.

In the function panel, when you click the control or press <Enter>, <Spacebar>, or <Ctrl-down arrow>, a dialog box appears containing a hierarchical list of the available attributes. Attributes whose values cannot be obtained are dimmed. Help text is shown for each attribute. To select an attribute, double-click it or select it and then press <Enter>.

If the attribute shown in this ring control has named constants as valid values, you can open a list of them by moving to the Attribute Value control and pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants.
attributeValue int The value to which to set the cursor attribute.

If the attribute shown in this ring control has named constants as valid values, you can open a list of them by pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants.

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