com.esri.arcgis.geoprocessing
Interface IGPMultiValue

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPMultiValue

public interface IGPMultiValue
extends Serializable

Provides access to the properties/methods of a multi-value object.

Remarks

Set both data type and value for a multi value object. See code examples in SDK help topic Building a custom geoprocessing function tool.

Product Availability

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

Method Summary

void	addValue(IGPValue value) Adds the given value object to the multi-value object.
int	getCount() The number of values currently contained in the multi-value object.
IGPDataType	getMemberDataType() The data type of value objects accepted by the multi-value object.
IGPValue	getValue(int index) The value at the specified index.
IEnumGPValue	getValues() An enumeration of values contained in the multi-value object.
void	insert(int index, IGPValue value) Inserts the given value object to the multi-value object at the specified index.
void	remove(int index) Removes the value object at the given index from the multi-value object.
void	removeValue(IGPValue value) Removes the given value object from the multi-value object.
void	replace(int index, IGPValue value) Replaces the value object at the given index with the given value object.
void	setMemberDataTypeByRef(IGPDataType type) The data type of value objects accepted by the multi-value object.

Method Detail

getValue

IGPValue getValue(int index)
                  throws IOException,
                         AutomationException

The value at the specified index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValues

IEnumGPValue getValues()
                       throws IOException,
                              AutomationException

An enumeration of values contained in the multi-value object.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMemberDataTypeByRef

void setMemberDataTypeByRef(IGPDataType type)
                            throws IOException,
                                   AutomationException

The data type of value objects accepted by the multi-value object.

Product Availability

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

Parameters:

type - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMemberDataType

IGPDataType getMemberDataType()
                              throws IOException,
                                     AutomationException

The data type of value objects accepted by the multi-value object.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

The number of values currently contained in the multi-value object.

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.

addValue

void addValue(IGPValue value)
              throws IOException,
                     AutomationException

Adds the given value object to the multi-value object.

Product Availability

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

Supported Platforms

Windows

Parameters:

value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IGPValue value)
            throws IOException,
                   AutomationException

Inserts the given value object to the multi-value object at the specified index.

Product Availability

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

Supported Platforms

Windows

Parameters:

index - The index (in)

value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeValue

void removeValue(IGPValue value)
                 throws IOException,
                        AutomationException

Removes the given value object from the multi-value object.

Product Availability

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

Supported Platforms

Windows

Parameters:

value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException

Removes the value object at the given index from the multi-value object.

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.

replace

void replace(int index,
             IGPValue value)
             throws IOException,
                    AutomationException

Replaces the value object at the given index with the given value object.

Product Availability

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

Supported Platforms

Windows

Parameters:

index - The index (in)

value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.