• Article

SqlGeometry.STPolyFromText Method

Returns a SqlGeometry 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 STPolyFromText ( _
    polygonTaggedText As SqlChars, _
    srid As Integer _
) As SqlGeometry
'Usage
Dim polygonTaggedText As SqlChars
Dim srid As Integer
Dim returnValue As SqlGeometry

returnValue = SqlGeometry.STPolyFromText(polygonTaggedText, _
    srid)

[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
public static SqlGeometry STPolyFromText(
    SqlChars polygonTaggedText,
    int srid
)

[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
public:
static SqlGeometry^ STPolyFromText(
    SqlChars^ polygonTaggedText, 
    int srid
)

[<SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)>]
static member STPolyFromText : 
        polygonTaggedText:SqlChars * 
        srid:int -> SqlGeometry 

public static function STPolyFromText(
    polygonTaggedText : SqlChars, 
    srid : int
) : SqlGeometry

Parameters

  • srid
    Type: System.Int32
    An int expression that represents the spatial reference ID (SRID) of the SqlGeometry Polygon instance you wish to return.

Return Value

Type: Microsoft.SqlServer.Types.SqlGeometry
A SqlGeometry object constructed from the specified WKT representation.

Remarks

This method will throw a FormatException if the input is not well-formatted.

This member is static.