com.esri.arcgis.geoprocessing
Interface IGpObjectArray

All Superinterfaces:

Serializable

All Known Implementing Classes:

GpObjectArray

public interface IGpObjectArray
extends Serializable

Provides access to the properties and methods of a Geoprocessing object array object.

Product Availability

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

Method Summary

void	add(Object pObject) Adds an object to the array.
void	esri_clone(IGpObjectArray pSrcObj) Assigns the properties of source array to this object.
int	getCount() The element count of the array.
Object	getObject(int element) Returns the object at the given index in the array.
void	insert(int element, Object pObject) Adds an object to the array at the specified index.
Object	next() Returns the next object at the current index in the array.
void	remove(int element) Removes the object at the specified index from the array.
void	removeAll() Removes all objects from the array.
void	replace(int element, Object pObject) Replaces the object at the specified index in the array.
void	reset() Sets the current enumeration index (used by the Next method) back to the first element in the array.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

The element count of the array.

Product Availability

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

Supported Platforms

Windows

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(Object pObject)
         throws IOException,
                AutomationException

Adds an object to the array.

Product Availability

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

Supported Platforms

Windows

Parameters:

pObject - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObject

Object getObject(int element)
                 throws IOException,
                        AutomationException

Returns the object at the given index in the array.

Product Availability

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

Supported Platforms

Windows

Parameters:

element - The element (in)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Sets the current enumeration index (used by the Next method) back to the first element in the array.

Product Availability

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

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

Object next()
            throws IOException,
                   AutomationException

Returns the next object at the current index in the array.

Product Availability

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

Supported Platforms

Windows

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int element)
            throws IOException,
                   AutomationException

Removes the object at the specified index from the array.

Product Availability

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

Supported Platforms

Windows

Parameters:

element - The element (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Removes all objects from the array.

Product Availability

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

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int element,
            Object pObject)
            throws IOException,
                   AutomationException

Adds an object to the array at the specified index.

Product Availability

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

Supported Platforms

Windows

Parameters:

element - The element (in)

pObject - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replace

void replace(int element,
             Object pObject)
             throws IOException,
                    AutomationException

Replaces the object at the specified index in the array.

Product Availability

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

Supported Platforms

Windows

Parameters:

element - The element (in)

pObject - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

void esri_clone(IGpObjectArray pSrcObj)
                throws IOException,
                       AutomationException

Assigns the properties of source array to this object.

Product Availability

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

Parameters:

pSrcObj - A reference to a com.esri.arcgis.geoprocessing.IGpObjectArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.