SqlGeography.STGeomCollFromWKB Method

Returns a GeometryCollection 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 SqlGeography
'Usage
Dim wkbGeometryCollection As SqlBytes
Dim srid As Integer
Dim returnValue As SqlGeography

returnValue = SqlGeography.STGeomCollFromWKB(wkbGeometryCollection, _
    srid)
[SqlMethodAttribute(IsDeterministic = true, IsPrecise = true)]
public static SqlGeography STGeomCollFromWKB(
    SqlBytes wkbGeometryCollection,
    int srid
)
[SqlMethodAttribute(IsDeterministic = true, IsPrecise = true)]
public:
static SqlGeography^ STGeomCollFromWKB(
    SqlBytes^ wkbGeometryCollection, 
    int srid
)
[<SqlMethodAttribute(IsDeterministic = true, IsPrecise = true)>]
static member STGeomCollFromWKB : 
        wkbGeometryCollection:SqlBytes * 
        srid:int -> SqlGeography
public static function STGeomCollFromWKB(
    wkbGeometryCollection : SqlBytes, 
    srid : int
) : SqlGeography

Parameters

  • srid
    Type: System.Int32
    An int expression representing the spatial reference ID (SRID) of the GeometryCollection instance you wish to return.

Return Value

Type: Microsoft.SqlServer.Types.SqlGeography
A SqlGeography value constructed from the specified WKB geometry collection.

Remarks

The OGC type of the SqlGeography instance returned by STGeomCollFromWKB is set to GeometryCollection, MultiPolygon, MultiLineString, or MultiPoint, depending on the corresponding WKB input.

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

See Also

Reference

SqlGeography Class

Microsoft.SqlServer.Types Namespace