• Article

SqlGeography.STGeomFromWKB Method

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

returnValue = SqlGeography.STGeomFromWKB(wkbGeometry, _
    srid)

[SqlMethodAttribute(IsDeterministic = true, IsPrecise = true)]
public static SqlGeography STGeomFromWKB(
    SqlBytes wkbGeometry,
    int srid
)

[SqlMethodAttribute(IsDeterministic = true, IsPrecise = true)]
public:
static SqlGeography^ STGeomFromWKB(
    SqlBytes^ wkbGeometry, 
    int srid
)

[<SqlMethodAttribute(IsDeterministic = true, IsPrecise = true)>]
static member STGeomFromWKB : 
        wkbGeometry:SqlBytes * 
        srid:int -> SqlGeography 

public static function STGeomFromWKB(
    wkbGeometry : SqlBytes, 
    srid : int
) : SqlGeography

Parameters

  • srid
    Type: System.Int32
    An int expression that represents the Spatial Reference ID (SRID) of the SqlGeography instance you wish to return.

Return Value

Type: Microsoft.SqlServer.Types.SqlGeography
A SqlGeography instance constructed from the specified WKB representation.

Remarks

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

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