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.

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
itemLabel string 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-precision Value associated with the label string.

You can pass NULL.

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