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.

Parameters

Input
Name Type Description
panelHandle integer Specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
controlID integer 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 NewCtrl or DuplicateCtrl.
axis integer 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 integer Zero-based index into the list of label strings.
Output
Name Type Description
length string Length, in bytes, of the selected label string. Excludes the terminating NUL byte.

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success