• Article

SqlGeometry.STGeomCollFromWKB Method

Returns a SqlGeometry collection instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation.

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

Syntax

'Declaration
<SqlMethodAttribute(IsDeterministic := True, IsPrecise := True)> _
Public Shared Function STGeomCollFromWKB ( _
    wkbGeometryCollection As SqlBytes, _
    srid As Integer _
) As SqlGeometry
'Usage
Dim wkbGeometryCollection As SqlBytes
Dim srid As Integer
Dim returnValue As SqlGeometry

returnValue = SqlGeometry.STGeomCollFromWKB(wkbGeometryCollection, _
    srid)

[SqlMethodAttribute(IsDeterministic = true, IsPrecise = true)]
public static SqlGeometry STGeomCollFromWKB(
    SqlBytes wkbGeometryCollection,
    int srid
)

[SqlMethodAttribute(IsDeterministic = true, IsPrecise = true)]
public:
static SqlGeometry^ STGeomCollFromWKB(
    SqlBytes^ wkbGeometryCollection, 
    int srid
)

[<SqlMethodAttribute(IsDeterministic = true, IsPrecise = true)>]
static member STGeomCollFromWKB : 
        wkbGeometryCollection:SqlBytes * 
        srid:int -> SqlGeometry 

public static function STGeomCollFromWKB(
    wkbGeometryCollection : SqlBytes, 
    srid : int
) : SqlGeometry

Parameters

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

Return Value

Type: Microsoft.SqlServer.Types.SqlGeometry
A SqlGeometry collection constructed from the specified WKB representation.

Remarks

The OGC type of the SqlGeometry instance returned by STGeomCollFromWKB is set to GeomCollection, MultiPolygon, MultiLineString, or MulitPoint, depending on the corresponding WKB input.

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

This member is static.