[Back to Interface] [Prev] [Next]

SDgetdimstrs/sfgdmstr

intn SDgetdimstrs(int32 dim_id, char *label, char *unit, char *format, intn length)

dim_id IN:

Dimension identifier returned by SDgetdimid

label OUT:

Label (predefined attribute)

unit OUT:

Unit (predefined attribute)

format OUT:

Format (predefined attribute)

length IN:

Maximum length of the above predefined attributes

Purpose

Retrieves the predefined attributes of a dimension.

Return value

Returns SUCCEED (or 0) if successful and FAIL (or -1) otherwise.

Description

SDgetdimstrs retrieves the predefined attributes associated with the dimension identified by the parameter dim_id. The predefined attributes are label, unit, and format. These predefined attributes are stored in the parameters label, unit, and format, respectively. Refer to Section 3.10 of the HDF User's Guide for more information on predefined attributes.

If a particular data string was not stored, the first character of the corresponding SDgetdimstrs parameter is '\0'. Each string buffer must include space for the null termination character. If a user does not want a string returned, the corresponding parameter can be set to NULL in C and an empty string in Fortran. The predefined attributes are set by SDsetdimstrs.

FORTRAN

integer function sfgdmstr(dim_id, label, unit, format, length)

integer dim_id, length

character*(*) label, unit, format



[Back to Interface] [Prev] [Next]

hdfhelp@ncsa.uiuc.edu
HDF Reference Manual - 07/29/98, NCSA HDF Development Group.