com.esri.arcgis.geoprocessing
Interface IGPToolInfos

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPToolInfos

public interface IGPToolInfos
extends Serializable

Provides access to the properties/methods of the tool information array.

Product Availability

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

Method Summary

void	add(IGPToolInfo pInfo) Adds a tool to the array.
int	getCount() The size of the array.
IGPToolInfo	getElement(int index) The tool at the specified index in the array.
void	insert(int index, IGPToolInfo pInfo) Adds a tool to the array at the specified index.
void	remove(int index) Removes a tool from the array.
void	removeAll() Removes all tools from the array.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

The size of the array.

Product Availability

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

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElement

IGPToolInfo getElement(int index)
                       throws IOException,
                              AutomationException

The tool at the specified index in the array.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPToolInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(IGPToolInfo pInfo)
         throws IOException,
                AutomationException

Adds a tool to the array.

Product Availability

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

Parameters:

pInfo - A reference to a com.esri.arcgis.geoprocessing.IGPToolInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IGPToolInfo pInfo)
            throws IOException,
                   AutomationException

Adds a tool to the array at the specified index.

Product Availability

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

Parameters:

index - The index (in)

pInfo - A reference to a com.esri.arcgis.geoprocessing.IGPToolInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException

Removes a tool from the array.

Product Availability

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

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Removes all tools from the array.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.