|
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. |