GCC_GetCursorName
- Updated2023-02-21
- 1 minute(s) read
int GCC_GetCursorName (GraphCursorCtrlHandle graphCursorControl, int cursorNumber, char cursorName[]);
Purpose
This function returns the name of the specified cursor in the graph cursor control.
Parameters
| Input | ||
| Name | Type | Description |
| graphCursorControl | GraphCursorCtrlHandle | The handle to the graph cursor control returned by GCC_New. |
| cursorNumber | int | The number of the cursor whose name will be returned. |
| Output | ||
| Name | Type | Description |
| cursorName | char [] | The name of the specified cursor. You must pass a buffer that can hold the entire name plus the trailing NUL byte. You can call GCC_GetCursorNameLength to obtain the length of the name of the cursor. |
Return Value
| Name | Type | Description |
| result | int | The return value of the function. User interface error codes as documented in userint.h are returned. |
Additional Information
Library: Graph Cursor Control
Include file: custctrl\graphcursors.h
LabWindows/CVI compatibility: LabWindows/CVI 6.0 and later
Example
Refer to userint\custctrl\graphcursors\graphcursorctrl.cws for an example of using the GCC_GetCursorName function.