GetAxisItem
int GetAxisItem (int panelHandle, int controlID, int axis, int itemIndex, char itemLabel[], double *itemValue);
Purpose
Obtains the string/value pair at a specific index in the list of label strings for a graph or strip chart axis.
Supported Controls
You can use GetAxisItem with the following 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. |
axis | int | Specifies for which axis to obtain the mode and range. The following lists the valid values: VAL_BOTTOM_XAXIS (graphs only) VAL_TOP_XAXIS (graphs only) VAL_LEFT_YAXIS (graphs and strip charts) VAL_RIGHT_YAXIS (graphs only) |
itemIndex | int | Zero-based index into the list of label strings. |
Output | ||
Name | Type | Description |
itemLabel | char [] | Buffer in which the label string is returned. itemLabel must be large enough to hold the label string, including the terminating NUL byte. You can use GetAxisItemLabelLength to determine the length of the label string. You can pass NULL. |
itemValue | double | Value associated with the label string. You can pass NULL. |
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 4.0 and later