This document is archived and information here might be outdated.  Recommended version.


IGPParameter Interface (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (Geoprocessing)  

IGPParameter Interface

Provides access to the properties/methods of a geoprocessing parameter object. Note: the IGPParameter interface has been superseded byIGPParameter3. Please consider using the more recent version.

Product Availability

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

Members

Description
Read-only property Altered Indicates whether the parameter value has been explicitly set (by the user).
Read-only property Category Category of the geoprocessing parameter.
Read-only property ChoiceList The choice list object of the geoprocessing parameter.
Read-only property ControlCLSID The class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing parameter.
Read-only property DataType Data type of the geoprocessing parameter.
Read-only property DefaultEnvironmentName The name of the environment value to use as the default value for the geoprocessing parameter.
Read-only property Direction Direction of the geoprocessing parameter.
Read-only property DisplayName Display name of the geoprocessing parameter.
Read-only property DisplayOrder The display order of the geoprocessing parameter.
Read-only property Domain Domain of the geoprocessing parameter.
Read-only property Enabled Indicates whether the ActiveX control for the geoprocessing parameter should be enabled/disabled.
Read-only property HasBeenValidated Indicates whether the parameter value has been modified since the last time the parameter was validated (i.e., since Validate() was called).
Read-only property Name Name of the geoprocessing parameter.
Read-only property ParameterDependencies Enumeration of parameter names the geoprocessing parameter is dependent on.
Read-only property ParameterType Type of the geoprocessing parameter.
Read-only property Value The current value object of the geoprocessing parameter.

CoClasses that implement IGPParameter

CoClasses and Classes Description
GPParameter Geoprocessing Parameter object.
MdParameter Model parameter object that references a model variable or contains a value object.

Remarks

The IGPParameter provides access to the properties that identify the characteristics for a geoprocessing tool’s parameter. The ParameterInfo property of the IGPFunction returns an array of IGPParameter objects. Also refer to Building Geoprocessing Function Tools.

 

See also IGPParameterEdit, IGPFunction.

.NET Samples

Calculate area geoprocessing function tool (Code Files: CalculateAreaFunction)

.NET Related Topics

Running a geoprocessing tool using background geoprocessing