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


IBasicGeoprocessor.Clip Method (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Carto)  

IBasicGeoprocessor.Clip Method

Clips features.

[Visual Basic .NET]
Public Function Clip ( _
    ByVal inputTable As ITable, _
    ByVal useSelectedInput As Boolean, _
    ByVal clipTable As ITable, _
    ByVal useSelectedClip As Boolean, _
    ByVal Tolerance As Double, _
    ByVal outputName As IFeatureClassName _
) As IFeatureClass
[C#]
public IFeatureClass Clip (
    ITable inputTable,
    bool useSelectedInput,
    ITable clipTable,
    bool useSelectedClip,
    double Tolerance,
    IFeatureClassName outputName
);
[C++]
HRESULT Clip(
  ITable* inputTable,
  VARIANT_BOOL useSelectedInput,
  ITable* clipTable,
  VARIANT_BOOL useSelectedClip,
  double Tolerance,
  IFeatureClassName* outputName,
  IFeatureClass** resultFC
);
[C++]

Parameters inputTable [in]
inputTable is a parameter of type ITable useSelectedInput [in] useSelectedInput is a parameter of type VARIANT_BOOL clipTable [in]
clipTable is a parameter of type ITable useSelectedClip [in] useSelectedClip is a parameter of type VARIANT_BOOL Tolerance [in] Tolerance is a parameter of type double outputName [in]
outputName is a parameter of type IFeatureClassName resultFC [out, retval]
resultFC is a parameter of type IFeatureClass

Product Availability

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

Description

Clip extracts features of a point, line, or polygon layer based on the spatial extent of an overlay polygon layer. The attributes of the input feature class are carried over to the output feature class.

Remarks

The inputTable is the data to be clipped.

The clipTable parameter is the data that will be used to perform the clip.

The useSelectedInput state refers to whether or not a selected subset of the InputTable is to be clipped. True signifies that a selected subset will be clipped. False signifies that clip operation will ignore any selected subset.

The useSelectedClip state refers to whether or not a selected subset of the clipTable is to be used in the clip operation. True signifies that the selected subset will serve as the clip layer. False signifies that the clip operation will ignore any selected subset.

Passing 0.0 causes the default tolerance to be used. The default tolerance is 1/10,000 of the extent of the data frame's spatial domain.

See Also

IBasicGeoprocessor Interface