ArcObjects Library Reference (Geoprocessing)  

IGPUtilities.InternalValidate Method

Performs a validation of the parameters to a GPTool.

[Visual Basic .NET]
Public Function InternalValidate ( _
    ByVal pParameters As IArray, _
    ByVal pParamValues As IArray, _
    ByVal updateValues As Boolean, _
    ByVal honorDerivedFlag As Boolean, _
    ByVal pEnvMgr As IGPEnvironmentManager _
) As IGPMessages
[C#]
public IGPMessages InternalValidate (
    IArray pParameters,
    IArray pParamValues,
    bool updateValues,
    bool honorDerivedFlag,
    IGPEnvironmentManager pEnvMgr
);
[C++]
HRESULT InternalValidate(
  IArray* pParameters,
  IArray* pParamValues,
  VARIANT_BOOL updateValues,
  VARIANT_BOOL honorDerivedFlag,
  IGPEnvironmentManager* pEnvMgr,
  IGPMessages** ppMessages
);
[C++]

Parameters

pParameters [in]

  pParameters is a parameter of type IArray

pParamValues [in]

  pParamValues is a parameter of type IArray

updateValues [in]   updateValues is a parameter of type VARIANT_BOOL honorDerivedFlag [in]   honorDerivedFlag is a parameter of type VARIANT_BOOL pEnvMgr [in]

  pEnvMgr is a parameter of type IGPEnvironmentManager

ppMessages [out, retval]

  ppMessages is a parameter of type IGPMessages

Product Availability

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

Remarks

The InternalValidate method is called during Validate, when it performs checks on required data elements to ensure they exist and are valid. In particular, it verifies data types and their values against data definitions, and if the values are members of a defined domain. InternalValidate also checks geoprocessing environment settings.

See Also

IGPUtilities Interface