com.esri.arcgis.geodatabase
Interface IEnumLocatorName

All Superinterfaces:

Serializable

All Known Implementing Classes:

IEnumLocatorNameProxy, LocatorNameEnumerator

public interface IEnumLocatorName
extends Serializable

Provides access to members to retrieving a set of Name objects for locators.

When To Use

Use the IEnumLocatorName interface to inspect the set of LocatorName objects contained in a LocatorNameEnumerator. A LocatorNameEnumerator can be retrieved from a locator workspace using the ILocatorWorkspace::LocatorNames method.

Product Availability

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

Method Summary

IEnumLocatorName	esri_clone() Creates a copy of the enumeration.
int	getCount() Number of Name objects in the enumeration.
ILocatorName	next() Returns the next Name object.
ILocatorName	previous() Returns the previous Name object.
void	reset() Resets the enumeration.

Method Detail

next

ILocatorName next()
                  throws IOException,
                         AutomationException

Returns the next Name object.

Description

The Next method returns the next LocatorName object in the LocatorNameEnumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

previous

ILocatorName previous()
                      throws IOException,
                             AutomationException

Returns the previous Name object.

Description

The Previous method returns the previous LocatorName object in the LocatorNameEnumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Resets the enumeration.

Remarks

The Reset method resets the LocatorNameEnumerator so that the next call to the Next method returns the first LocatorName object in the LocatorNameEnumerator. The Reset method should always be called on a LocatorNameEnumerator immediately after retrieving it from a locator workspace.

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.

esri_clone

IEnumLocatorName esri_clone()
                            throws IOException,
                                   AutomationException

Creates a copy of the enumeration.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

Number of Name objects in the enumeration.

Description

The Count property returns the number of LocatorName objects in the LocatorNameEnumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.