com.esri.arcgis.system
Interface IEnumBSTR

All Superinterfaces:
Serializable
All Known Implementing Classes:
EnumBSTR

public interface IEnumBSTR
extends Serializable

Provides access to members that enumerate over a set of strings.

Description

IEnumBSTR provides access to a set of strings (a BSTR is a particular COM representation of a string that is compatible with VB). An empty string is returned by Next when there are no more strings to fetch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 String next()
          Returns the next string in the list.
 void reset()
          Resets the string so the next returned string is the first.
 

Method Detail

next

String next()
            throws IOException,
                   AutomationException
Returns the next string in the list.

Description

The Next method returns the next string in the enumerator. An empty string is returned by Next when there are no more strings to fetch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pBSTR
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException
Resets the string so the next returned string is the first.

Description

The Reset method resets the enumerator so that the next call to the Next method returns the first string 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.