IGPValue Interface

Provides access to members of a GPValue.

When To Use

The IGPValue interface provides access to the property and methods required to create and define a Value object.

Values are the actual inputs to a tool containing scalars or paths to the data.

An array of values is created, based on the same order of the parameter definiton of a geoprocessing tool. This array of values is then used as input to both the Validate and Execute methods of the tool.

A complete example to create a geoprocessing function tool, including the use of IGPValue, is available here: Building Geoprocessing Function Tools .

See also IGPDataType

Members

Name Description
Read-only property DataType The data type of the value object.
Method Empty Clears the value object.
Method GetAsText Provides the value of the value object.
Method IsEmpty Indicates if the value object is empty.
Method SetAsText Provides the value of the value object with the given string value.

IGPValue.DataType Property

The data type of the value object.

Public ReadOnly Property DataType As IGPDataType
public IGPDataType DataType {get;}

Remarks

The DataType property returns the DataType object associated with this Value object.

IGPValue.Empty Method

Clears the value object.

Public Sub Empty ( _
)
public void Empty (
);

Remarks

The Empty method clears this Value object and releases any associated objects.

IGPValue.GetAsText Method

Provides the value of the value object.

Public Function GetAsText ( _
) As String
public string GetAsText (
);

Remarks

The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.

IGPValue.IsEmpty Method

Indicates if the value object is empty.

Public Function IsEmpty ( _
) As Boolean
public bool IsEmpty (
);

Remarks

The IsEmpty method returns if this Value object has been set or not.

IGPValue.SetAsText Method

Provides the value of the value object with the given string value.

Public Function SetAsText ( _
    ByVal text As String _
) As IGPMessage
public IGPMessage SetAsText (
    string text
);

Remarks

The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.

Classes that implement IGPValue

Classes Description
DENetworkDataset Network Dataset Data Element object.
Field Esri Field object.
FullTextIndexDefinition Esri FullTextIndex Definition object.
Index Esri Index object.
XMLIndex XML Index Object.
XMLIndexTag XML Index Tag Object.
XMLIndexTags XML Index Tags Collection Object.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.