com.esri.arcgis.geoprocessing
Interface IBStringArray

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
EnumBSTR, IBStringArrayProxy

public interface IBStringArray
extends java.io.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(java.lang.String str)
          Adds a string to the array.
 int getCount()
          The size of the array.
 java.lang.String getString(int index)
          The string at the specified index in the array.
 void insertString(int index, java.lang.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, java.lang.String str)
          Replaces a string in the array.
 

Method Detail

getCount

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

Supported Platforms

Windows

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

getString

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

Supported Platforms

Windows

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

addString

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

Supported Platforms

Windows

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

insertString

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

Supported Platforms

Windows

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

removeString

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

Supported Platforms

Windows

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

removeAll

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

Supported Platforms

Windows

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

replaceString

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

Supported Platforms

Windows

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