Routines (alphabetical) > Routines: H > HDF-EOS Routines > EOS_SW_REGIONINFO

# EOS_SW_REGIONINFO

This function returns information about a subsetted region for a particular field. Because of differences in number type and geolocation mapping, a given region will give different values for the dimensions and size for various fields.

Note: Array ordering of variables used or returned by this routine changed in IDL 5.5. Programs written for versions of this routine prior to IDL 5.5 may need to be modified to work correctly with the current version.

## Examples

In this example, we retrieve information about the region defined in EOS_SW_DEFBOXREGION for the Spectra field:

status = EOS_SW_REGIONINFO(EOS_SW_id, regionID, "Spectra", $

ntype, rank, dims, size)

## Syntax

Result = EOS_SW_REGIONINFO(swathID, regionID, fieldname, ntype, rank, dims, size)

## Return Value

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

## Arguments

### swathID

Swath id (long) returned by EOS_SW_CREATE or EOS_SW_ATTACH.

### regionID

Region id (long) returned by EOS_SW_DEFBOXREGION.

### fieldname

Field to subset (string).

### ntype

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

### rank

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

### dims

A named variable that will contain the dimensions of subset region (long).

### size

A named variable that will contain the size in bytes of subset region (long).

## Keywords

None

## Version History

5.2 | Introduced