[Top] [Prev] [Next] [Bottom]

SDdiminfo/sfgdinfo

intn SDdiminfo(int32 dim_id, char *name, int32 *count, int32 *data_type, int32 *nattrs)
dim_id

IN:

Dimension identifier returned from SDgetdimid

name

OUT:

Array to retrieve dimension name

count

OUT:

Size of the dimension

data_type

OUT:

Data type of the data stored in the dataset

nattrs

OUT:

Attribute count assigned to the dimension's coordinate variable

Purpose

Retrieves information about a dimension.

Return value

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

Description

If scale information has been stored for this dimension via SDsetdimscale, data_type will contain the data type - otherwise, data_type will be 0. If the user has not named the dimension via SDsetdimname a place holder will be generated by the library. If the name is unimportant, NULL can be passed in for the name parameter.

The count argument is set to SD_UNLIMITED for unlimited dimensions. To get the number of records of an unlimited dimension, use SDgetinfo.

If "label, unit, format" metadata (or "LUF" metadata) is assigned to a dimenstion, it will be "promoted" by the SD interface to be a variable. If the target dimension specfied by dim_id is a varaible, the value returned in the data_type argument will be 0.

FORTRAN

integer function sfgdinfo(dim_id, name, count, data_type, nattrs)

character* (*) name

integer dim_id, count, data_type, nattrs



[Top] [Prev] [Next] [Bottom]

hdfhelp@ncsa.uiuc.edu
HDF User's Reference Manual, Draft 06/09/97, NCSA HDF Development Group.