This function retrieves information on a specific data field.

Examples


In this example, we retrieve information about the Spectra data fields:

status = EOS_SW_FIELDINFO(swathID, "Spectra", rank, dims, $ 
   numbertype, dimlist)

Syntax


Result = EOS_SW_FIELDINFO(swathID, fieldname, rank, dims, numbertype, dimlist)

Return Value


Returns SUCCEED(0) if successful and FAIL(–1) if the specified field does not exist.

Arguments


swathID

Swath id (long).

fieldname

Fieldname (string).

rank

A named variable that will contain the rank of field (long).

dims

A named variable that will contain the array of length “rank” (long) containing the dimension sizes of the field. If one of the dimensions in the field is appendable, then the current value for that dimension will be returned in the dims array.

numbertype

A named variable that will contain HDF data type of the field.

dimlist

A named variable that will contain the list of dimensions (string) in field.

Keywords


None

Version History


5.2

Introduced