|
Purpose
|
Retrieves information about a dimension. |
|
Return value
|
Returns SUCCEED (or 0) if successful and FAIL (or -1) otherwise. |
|
Description
|
SDdiminfo retrieves the name, size, data type, and number of values of the dimension specified by the parameter dim_id, and stores them in the parameters name, size, data_type, and num_attrs, respectively. |
|
|
If the output value of the parameter size is set to 0, then the dimension specified by the dim_id parameter is unlimited. To get the number of records of an unlimited dimension, use SDgetinfo. |
|
|
If scale information has been stored for this dimension via SDsetdimscale, the data_type parameter will contain the data type. Valid data types can be found in Table 1A of Section I of this manual. If no scale information has been stored for this dimension, the value returned in the data_type parameter will be 0. |
|
|
If the user has not named the dimension via SDsetdimname, a default dimension name of "fakeDim[x]" will be generated by the library, where [x] denotes the dimension index. If the name is not desired, the parameter name can be set to NULL in C and an empty string in Fortran. |