[Top]
[Prev]
[Next]
[Bottom]
SDgetdimstrs/sfgdmstr
intn SDgetdimstrs(int32
dim_id
, char *
label
, char *
unit
, char *
format
, intn
len
)
dim_id
IN:
Dimension identifier returned from
SDgetdimid
label
OUT:
Label that describes this dimension
unit
OUT:
Unit to be used with this dimension
format
OUT:
Format to be used in displaying scale for this dimension
len
IN:
Maximum string length it is safe to return
Purpose
Retrieves the label, unit, and format strings for a given dimension.
Return value
Returns SUCCEED (or 0) if successful and FAIL (or -1) otherwise.
Description
This routine returns the dimension strings stored by
SDsetdimstrs
. If a particular string was not stored, the first character of the return string will be '\0'. Each string buffer is assumed to be at least
len
characters long. If a user does not want a string returned, NULL can be passed for any of the string values.
FORTRAN
integer function sfgdmstr(dim_id, label, unit, format, len)
integer dim_id, len
character* (*) label, unit, format
[Top]
[Prev]
[Next]
[Bottom]
hdfhelp@ncsa.uiuc.edu
HDF User's Reference Manual, Draft 06/09/97, NCSA HDF Development Group.