SqlGeography.STLineFromText Method

Returns a SqlGeography instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation, augmented with any Z (elevation) and M (measure) values carried by the instance.

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

Syntax

'Declaration
<SqlMethodAttribute(IsDeterministic := True, IsPrecise := False)> _
Public Shared Function STLineFromText ( _
    lineStringTaggedText As SqlChars, _
    srid As Integer _
) As SqlGeography
'Usage
Dim lineStringTaggedText As SqlChars
Dim srid As Integer
Dim returnValue As SqlGeography

returnValue = SqlGeography.STLineFromText(lineStringTaggedText, _
    srid)
[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
public static SqlGeography STLineFromText(
    SqlChars lineStringTaggedText,
    int srid
)
[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
public:
static SqlGeography^ STLineFromText(
    SqlChars^ lineStringTaggedText, 
    int srid
)
[<SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)>]
static member STLineFromText : 
        lineStringTaggedText:SqlChars * 
        srid:int -> SqlGeography 
public static function STLineFromText(
    lineStringTaggedText : SqlChars, 
    srid : int
) : SqlGeography

Parameters

  • srid
    Type: System.Int32
    An int expression representing the Spatial Reference ID (SRID) of the SqlGeography LineString instance you wish to return.

Return Value

Type: Microsoft.SqlServer.Types.SqlGeography
A SqlGeography value constructed from the specified WKT representation.

Remarks

This method throws a FormatException if the input is not correctly formatted.