favGetAxisLabel
AVVIEWER Subroutine: Gets the axis label of the given axis.
Module: USE AVVIEWER
Syntax
- favGetAxisLabel (hv, axis, label, status)
- hv
-
A handle that references an instance of Array Viewer created by
favStartViewer.
- axis
-
An input argument of type INTEGER(4).
It specifies the desired axis for the label.
Use one of the named constants X_AXIS, Y_AXIS, or Z_AXIS.
- label
-
An input argument of type CHARACTER string.
It returns the label associated
with the given axis. The returned string is blank-filled at the end.
If the character length of this argument is less than the
length of the stored label, the action fails and a status code of -1 is returned.
If you do not know the length of the label, use a CHARACTER string of
length AV_MAX_LABEL_LEN.
- status
-
An output argument of type INTEGER(4). It returns a status code for the success of
this call. The value 0 indicates success.
See Also
favSetAxisLabel