com.esri.arcgis.system
Interface IEnumNamedID

All Superinterfaces:

Serializable

All Known Implementing Classes:

IEnumNamedIDProxy

public interface IEnumNamedID
extends Serializable

Provides access to members that enumerate over a set of named IDs.

Description

IEnumNamedID, which is used by the Paper object of esriOutput, provides browsing over a set of ID-name pairs. The ID is a long integer returned by the Next method. The name is a string returned as an ouput parameter of Next. When there are no more pairs to fetch, Next returns an empty name string.

Product Availability

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

Method Summary

int	next(String[] nextName) Obtains the next name-ID pair in the set.
void	reset() Resets internal cursor so that the next call to Next returns the first pair in the set.

Method Detail

next

int next(String[] nextName)
         throws IOException,
                AutomationException

Obtains the next name-ID pair in the set.

Description

The Next method returns the next ID and name pair in the enumerator. When there are no more pairs to fetch, Next returns an empty name string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

nextName - The nextName (out: use single element array)

Returns:

The identifier

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Resets internal cursor so that the next call to Next returns the first pair in the set.

Description

The Reset method resets the enumerator so that the next call to the Next method returns the first ID and name pair in the enumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.