com.esri.arcgis.controls
Interface IEngineEnumRow

All Superinterfaces:

Serializable

All Known Implementing Classes:

IEngineEnumRowProxy

public interface IEngineEnumRow
extends Serializable

Provides access to members that enumerate rows in sequence.

Description

This interface is new at ArcGIS 9.3.

Use the IEngineEnumRow enumeration object when you need to maintain a collection of IRow objects in engine. The collection itself can consist of any object that implements the IRow interface. For example, the Feature coclass implements the IRow interface so you can use the IEngineEnumRow object to maintain a collection of features.

The enumeration provides methods to cycle through it:

Use the Count method to identify how many objects exist within the collection.

Use the Next method to retrieve the next object in the enumeration.

Use the Reset method to reset the enumeration to the first object in the collection.

Product Availability

Available with ArcGIS Engine.

Method Summary

int	getCount() The number of rows.
IRow	next() Retrieves the next row in the sequence.
void	reset() Resets the enumeration sequence to the beginning.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

The number of rows.

Description

The property lists the total number of IRow objects in the enumeration.

Product Availability

Available with ArcGIS Engine.

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

IRow next()
          throws IOException,
                 AutomationException

Retrieves the next row in the sequence.

Description

This method retreives the next IRow object in the enumeration. If the enumeration has been reset, the Next method will return the first row in the enumeration. If the enumeration is at the end of its collection, the Next method will return a NULL object.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.geodatabase.IRow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Resets the enumeration sequence to the beginning.

Description

This method will reset the enumeration so that the Next method will retreive the first IRow object in the collection. Use the Reset method if you need to recycle the enumeration.

Product Availability

Available with ArcGIS Engine.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.