|
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. |