favGetDimName
AVVIEWER Subroutine: Gets the name that's associated with the given dimension.
Module: USE AVVIEWER
Syntax
- favGetDimName (hv, dim, name, status)
- hv
-
A handle that references an instance of Array Viewer created by
favStartViewer.
- dim
-
An output argument of type INTEGER(2). It specifies the dimension of the array.
The dimension must be in the range 0 to rank, where rank is the rank of the
currently loaded array.
- name
-
An output argument of type CHARACTER string. It returns the label associated with
the given dimension. 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
favSetDimName