com.esri.arcgis.geoprocessing
Interface IBStringArray

All Superinterfaces:
Serializable
All Known Implementing Classes:
EnumBSTR

public interface IBStringArray
extends Serializable

Provides access to the properties/methods of the string array.

Product Availability

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

Supported Platforms

Windows


Method Summary
 void addString(String str)
          Adds a string to the array.
 int getCount()
          The size of the array.
 String getString(int index)
          The string at the specified index in the array.
 void insertString(int index, String str)
          Adds a string to the array at the specified index.
 void removeAll()
          Removes all strings from the array.
 void removeString(int index)
          Removes a string from the array.
 void replaceString(int index, String str)
          Replaces a string in the array.
 

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException
The size of the array.

Product Availability

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

Supported Platforms

Windows

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

getString

String getString(int index)
                 throws IOException,
                        AutomationException
The string at the specified index in the array.

Product Availability

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

Parameters:
index - The index (in)
Returns:
The str
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addString

void addString(String str)
               throws IOException,
                      AutomationException
Adds a string to the array.

Product Availability

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

Supported Platforms

Windows

Parameters:
str - The str (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertString

void insertString(int index,
                  String str)
                  throws IOException,
                         AutomationException
Adds a string to the array at the specified index.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
str - The str (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeString

void removeString(int index)
                  throws IOException,
                         AutomationException
Removes a string from the array.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException
Removes all strings from the array.

Product Availability

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

Supported Platforms

Windows

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

replaceString

void replaceString(int index,
                   String str)
                   throws IOException,
                          AutomationException
Replaces a string in the array.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
str - The str (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.