ArcObjects Library Reference (GeoAnalyst)

IRasterAnalysisEnvironment.SetExtent Method

Sets the type and values of extent in the RasterAnalysis.

[Visual Basic .NET]
Public Sub SetExtent ( _
    ByVal envType As esriRasterEnvSettingEnum, _
    [ByRef extentProvider As Object], _
    [ByRef snapRasterData As Object] _
)

[C#]
public void SetExtent (
    esriRasterEnvSettingEnum envType,
    ref object extentProvider,
    ref object snapRasterData
);

[C#]

Optional Values

extentProvider To indicate that this parameter is undefined, first define a variable object Missing = Type.Missing; then pass this in as ref Missing.

snapRasterData To indicate that this parameter is undefined, first define a variable object Missing = Type.Missing; then pass this in as ref Missing.

[C++]
HRESULT SetExtent(
  esriRasterEnvSettingEnum envType,
  VARIANT* extentProvider,
  VARIANT* snapRasterData
);

[C++]

Parameters

envType [in]

envType is a parameter of type esriRasterEnvSettingEnum

extentProvider [optional] extentProvider is a parameter of type VARIANT

To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.

snapRasterData [optional] snapRasterData is a parameter of type VARIANT

To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.

Product Availability

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

Remarks

envType

An enumeration type specifying the raster extent environment settings for analysis. All subsequent results will be to this extent. It can be of type

esriRasterEnvMinOf – Intersection of Inputs - All input feature extents are intersected and the extent common to all is used as the extent values for the study area. This is the default.

esriRasterEnvMaxOf - Union of Inputs - All input feature extents are combined and the outer extent of the union is used.

esriRasterEnvValue - Value - User specified values for the Left, Right, Top and Bottom extent (x, y values) of the study area.

[extentProvider]

An envelope object supporting IEnvelope interface or RasterDataset that is used to provide the environment values of the analysis extent.

[snapRasterData]

A RasterDataset that can be used to snap all output raster datasets to the cell registration of the specified raster. All subsequent results will share the lower-left corner and cell size of the specified raster.

IRasterAnalysisEnvironment.SetExtent Method

Product Availability

Remarks

See Also