GetAxisItemLabelLength
int GetAxisItemLabelLength (int panelHandle, int controlID, int axis, int itemIndex, int *length);
Purpose
Obtains the number of bytes in a label string for a graph or strip chart axis. Specify the label string by its index in the list of string/value pairs for that axis.
The length returned does not include the terminating NUL byte.
Supported Controls
You can use GetAxisItemLabelLength 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 |
| length | int | Length, in bytes, of the selected label string. The length does not include the terminating NUL byte. |
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