SqlGeography.STGeomCollFromText Method

Returns a geography 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 STGeomCollFromText ( _
    geometryCollectionTaggedText As SqlChars, _
    srid As Integer _
) As SqlGeography
'Usage
Dim geometryCollectionTaggedText As SqlChars
Dim srid As Integer
Dim returnValue As SqlGeography

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

Parameters

  • geometryCollectionTaggedText
    Type: System.Data.SqlTypes.SqlChars
    Is the WKT representation of the geography instance you wish to return. geometrycollection_tagged_text is an nvarchar(max) expression.
  • srid
    Type: System.Int32
    Is an int expression representing the spatial reference ID (SRID) of the geography instance you wish to return.

Return Value

Type: Microsoft.SqlServer.Types.SqlGeography
A geography instance.

Remarks

The OGC type of the geography instance returned by STGeomCollFromText is set to the corresponding WKT input.

This method throws an ArgumentException if the input is not valid.