SqlGeometry.STGeomFromWKB Method

Returns a SqlGeometry 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 STGeomFromWKB ( _
    wkbGeometry As SqlBytes, _
    srid As Integer _
) As SqlGeometry
'Usage
Dim wkbGeometry As SqlBytes
Dim srid As Integer
Dim returnValue As SqlGeometry

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

Parameters

  • srid
    Type: System.Int32
    An int 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 object constructed from the specified WKB representation.

Remarks

The OGC type of the SqlGeometry instance returned by the STGeomFromText method is set to the corresponding WKB input.

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

This member is static.

See Also

Reference

SqlGeometry Class

Microsoft.SqlServer.Types Namespace