SqlGeography.STPolyFromWKB Method

Returns a SqlGeography Polygon 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 STPolyFromWKB ( _
    wkbPolygon As SqlBytes, _
    srid As Integer _
) As SqlGeography
'Usage
Dim wkbPolygon As SqlBytes
Dim srid As Integer
Dim returnValue As SqlGeography

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

Parameters

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

Return Value

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

Remarks

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