com.esri.arcgis.geoprocessing
Interface IGPParameterInfos

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPParameterInfos

public interface IGPParameterInfos
extends Serializable

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

Product Availability

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

Method Summary

void	add(IGPParameterInfo pParmInfo) Adds a parameter to the array.
int	getCount() The size of the array.
IGPParameterInfo	getElement(int index) The parameter at the specified index in the array.
void	insert(int index, IGPParameterInfo pParmInfo) Adds a parameter to the array at the specified index.
void	remove(int index) Removes a parameter from the array.
void	removeAll() Removes all parameters 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

IGPParameterInfo getElement(int index)
                            throws IOException,
                                   AutomationException

The parameter 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.IGPParameterInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(IGPParameterInfo pParmInfo)
         throws IOException,
                AutomationException

Adds a parameter to the array.

Product Availability

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

Parameters:

pParmInfo - A reference to a com.esri.arcgis.geoprocessing.IGPParameterInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IGPParameterInfo pParmInfo)
            throws IOException,
                   AutomationException

Adds a parameter to the array at the specified index.

Product Availability

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

Parameters:

index - The index (in)

pParmInfo - A reference to a com.esri.arcgis.geoprocessing.IGPParameterInfo (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 parameter 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 parameters 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.