GetImageFileInfo()
Summary
Gets information about a raster image file.
Syntax
a = GetImageFileInfo(string file_name)
| Argument | Contents |
|---|---|
| file_name | The full path and file name of the image file |
Returns
An array of information, as follows:
| Element | Type | Contents |
|---|---|---|
| 1 | Scope | The scope of the image or null if the image is not registered |
| 2 | Array | An array that indicates the number of wavelength bands in the image This is always null for TIFF format images |
Notes
-
For a full list of scope-related GISDK functions, see Map Scales and Scopes.
Error Codes
| Error Type | Meaning |
|---|---|
| Error | The image file is in a format that is not supported |
| NotFound | The specified file does not exist |
See Also
| Function | Summary |
|---|---|
| GetImageLayerOptions() | Gets the display and interpolation specifications of an image layer |
| RegisterImage() | Registers an image to a particular location, scale, and projection |
| SetImageLayerOptions() | Sets the display and interpolation specifications of an image layer |
| UnRegisterImageFile() | Removes registration information from a TIFF image file |