SqlGeography.STLength Method

Returns the total length of the elements in a SqlGeography instance or the SqlGeography instances within a GeometryCollection.

Namespace:  Microsoft.SqlServer.Types
Assembly:  Microsoft.SqlServer.Types (in Microsoft.SqlServer.Types.dll)

Syntax

'Declaration
<SqlMethodAttribute(IsDeterministic := True, IsPrecise := False)> _
Public Function STLength As SqlDouble
'Usage
Dim instance As SqlGeography
Dim returnValue As SqlDouble

returnValue = instance.STLength()
[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
public SqlDouble STLength()
[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
public:
SqlDouble STLength()
[<SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)>]
member STLength : unit -> SqlDouble 
public function STLength() : SqlDouble

Return Value

Type: System.Data.SqlTypes.SqlDouble
A SqlDouble value containing the total length.

Remarks

If a SqlGeography instance is closed, its length is calculated as the total length around the instance; the length of any polygon is its perimeter, and the length of a point is 0. The length of a GeometryCollection is found by calculating the sum of the lengths of all of the SqlGeography instances contained within the collection.