com.esri.arcgis.datasourcesraster
Interface IFormatList

All Superinterfaces:
Serializable
All Known Implementing Classes:
FormatList

public interface IFormatList
extends Serializable

Provides access to members that contain information about all raster formats currently supported.

When To Use

The FormatList object contains information about all available raster formats. It can be used to access this information or to check if a particular file is a raster and determine its format.

This object will provide information about all native formats and any formats that have been added to ArcMap by external developers. Formats that have multiple possible file extensions may appear more than once in this list.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getCount()
          Total number of formats.
 int getCurrentRecord()
          Index of currently accessed format information.
 IFormatData item(int index)
          Returns format information for a given index.
 void setCurrentRecord(int pVal)
          Index of currently accessed format information.
 

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException
Total number of formats.

Remarks

The number of count returned includes both external formats (such as IMG, GRID, or TIFF etc) and internal formats (such as RRD or AUX etc.). To get only the supported external raster formats, use IFormatData::UserFile = true to filter out the internal formats.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

item

IFormatData item(int index)
                 throws IOException,
                        AutomationException
Returns format information for a given index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IFormatData
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentRecord

int getCurrentRecord()
                     throws IOException,
                            AutomationException
Index of currently accessed format information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentRecord

void setCurrentRecord(int pVal)
                      throws IOException,
                             AutomationException
Index of currently accessed format information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.