com.esri.arcgis.location
Interface IEnumReferenceDataField

All Superinterfaces:
Serializable
All Known Implementing Classes:
IEnumReferenceDataFieldProxy, ReferenceDataFieldsEnumerator

public interface IEnumReferenceDataField
extends Serializable

Provides access to members for retrieving the reference data fields.

When To Use

Use the IEnumReferenceDataField interface to retrieve the ReferenceDataFields contained by the enumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ReferenceDataIndex, IReferenceDataFieldEdit, ReferenceDataFieldsEnumerator, ReferenceDataTableEnumerator, IReferenceDataField, IReferenceDataTableEdit, ESRIFDOAddressLocator, IReferenceDataFile.getPathName(), StreetMapAddressLocator, IEnumReferenceDataField, IReferenceDataFile, IReferenceDataTable, IReferenceDataTables, IReferenceDataTables.getTables(), ReferenceDataField, IReferenceDataFile.getFilters(), IEnumReferenceDataTable, ReferenceDataTable, IAddressGeocoding.validate(), ReferenceDataIndexEnumerator, IEnumReferenceDataIndex

Method Summary
 int getCount()
          The number of reference data fields in the reference data table.
 IReferenceDataField next()
          Returns the next reference data field.
 void reset()
          Resets the enumeration.
 

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException
The number of reference data fields in the reference data table.

Remarks

The Count property returns the number of ReferenceDataFields contained by the enumerator.

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.

next

IReferenceDataField next()
                         throws IOException,
                                AutomationException
Returns the next reference data field.

Description

Returns the next ReferenceDataField from the enumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.location.IReferenceDataField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException
Resets the enumeration.

Description

The Reset method resets the ReferenceDataFieldsEnumerator so that the Next method returns the first ReferenceDataField from the enumerator.

Remarks

You should use this method immediately after obtaining the ReferenceDataFieldsEnumerator from the locator. You need to use this method before querying the Count property or calling the Next method.

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.