SqlGeography.STArea Method

Returns the total surface area of a SqlGeography instance.

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

Syntax

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

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

Return Value

Type: System.Data.SqlTypes.SqlDouble
A SqlDouble value specifying the total surface area. STArea will return 0 if a SqlGeography instance contains only 0- and 1-dimensional figures, or if it is empty.

Remarks

Results for STArea are returned in the square of the unit of measure used by the spatial reference identifier of the geography instance; for example, if the SRID of the instance is 4326, STArea returns results in square meters.