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


ISurface.GetProfile Method (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (GeoDatabase)  

ISurface.GetProfile Method

Returns a polyline with z values interpolated from the surface.

[Visual Basic .NET]
Public Sub GetProfile ( _
    ByVal pShape As IGeometry, _
    ByRef ppProfile As IGeometry, _
    [ByRef pStepSize As Object] _
)
[C#]
public void GetProfile (
    IGeometry pShape,
    ref IGeometry ppProfile,
    ref object pStepSize
);
[C#]

Optional Values

pStepSize   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing.
[C++]
HRESULT GetProfile(
  IGeometry* pShape,
  IGeometry** ppProfile,
  VARIANT* pStepSize
);
[C++]

Parameters pShape [in]
pShape is a parameter of type IGeometry ppProfile [out]
ppProfile is a parameter of type IGeometry pStepSize [optional] pStepSize 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.

Description

Takes an input polyline or polygon, interpolates heights for it from the surface, and outputs the result as 3D geometry.

The input geometry should be polyline or polygon based. Portions of the input not falling within the interpolation zone of the surface will be clipped. A Null pointer ('Nothing' in Visual Basic) is returned when the input falls entirely off the surface.

If specified, the input geometry will be densified by the stepSize. This takes place before interpolating heights from the surface. The densification ensures no two vertices are spaced more than stepSize apart.

Notes:

See Also

ISurface Interface