GetZsFromSurfaceAsync(Geometry,String) Method

Obtains a geometry that is similar to the given input geometry, where all Z values are populated from an Elevation Surface identified by the given surface name.

Syntax

C#
Visual Basic (Declaration)

public Task<SurfaceZsResult> GetZsFromSurfaceAsync( 
   Geometry geometry,
   string surfaceName
)

Public Overloads Function GetZsFromSurfaceAsync( _
   ByVal geometry As Geometry, _
   ByVal surfaceName As String _
) As Task(Of SurfaceZsResult)

Parameters

geometry: the input geometry
surfaceName: identifies the surface to be used - if specified null, then the default Ground Surface will be used

Return Value

a result that contains a status , plus an output geometry only if the status is favorable

Exceptions

Exception	Description
System.ArgumentNullException	the input geometry is null
System.ArgumentException	this Map does not have a surface named surfaceName
System.ArgumentException	this Map does not have a default Ground Surface (when surfaceName is specified null)
System.InvalidOperationException	this Map does not have a CIM definition
System.InvalidOperationException	this Map does not have any surfaces

Remarks

If the surface has no data at a particular input geometry point or vertex, then the corresponding output geometry point or vertex Z will be set to the value specified in SurfaceZsMissingHandler.DefaultOutputZ.

Requirements

Target Platforms: Windows 10, Windows 8.1

Reference

Map Class
Map Members
Overload List