[Back to Interface] [Prev] [Next]

GRgetiminfo/mggiinf

intn GRgetiminfo(int32 ri_id, char *gr_name, int32 *ncomp, int32 *data_type, int32 *interlace_mode, int32 dim_sizes[2], int32 *num_attrs)

ri_id IN:

Raster image identifier returned by GRcreate or GRselect

gr_name OUT:

Buffer for the name of the raster image

ncomp OUT:

Number of components in the raster image

data_type OUT:

Data type of the raster image data

interlace_mode OUT:

Interlace mode of the stored raster image data

dim_sizes OUT:

Sizes of raster image dimension

num_attrs OUT:

Number of attributes attached to the raster image

Purpose

Retrieves general information about a raster image.

Return value

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

Description

GRgetiminfo retrieves the name, number of components, data type, interlace mode, dimension sizes, and number of attributes of the raster image identified by the parameter ri_id.

GRgetiminfo stores the name, number of components, data type, interlace mode and dimension sizes of the image in the parameters gr_name, ncomp, data_type, interlace_mode, and dim_sizes, respectively. It also retrieves the number of attributes attached to the image into the parameter num_attrs. If the value of any of the output parameters are set to NULL in C, the corresponding information will not be retrieved.

The buffer gr_name is assumed to have sufficient space allocated to store the entire name of the raster image.

The valid values of the parameter data_type are listed in Table 1A in Section I of this manual.

FORTRAN

integer function mggiinf(ri_id, gr_name, ncomp, data_type, interlace_mode, dim_sizes, num_attrs)

integer ri_id, ncomp, data_type, interlace_mode, num_attrs

integer dim_sizes[2]

character*(*) gr_name



[Back to Interface] [Prev] [Next]

hdfhelp@ncsa.uiuc.edu
HDF Reference Manual - 07/29/98, NCSA HDF Development Group.