• Article

SqlGeography.InstanceOf Method

Tests if the SqlGeography instance is the same as the specified type.

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

Syntax

'Declaration
<SqlMethodAttribute(IsDeterministic := True, IsPrecise := True)> _
Public Function InstanceOf ( _
    geometryType As String _
) As SqlBoolean
'Usage
Dim instance As SqlGeography
Dim geometryType As String
Dim returnValue As SqlBoolean

returnValue = instance.InstanceOf(geometryType)

[SqlMethodAttribute(IsDeterministic = true, IsPrecise = true)]
public SqlBoolean InstanceOf(
    string geometryType
)

[SqlMethodAttribute(IsDeterministic = true, IsPrecise = true)]
public:
SqlBoolean InstanceOf(
    String^ geometryType
)

[<SqlMethodAttribute(IsDeterministic = true, IsPrecise = true)>]
member InstanceOf : 
        geometryType:string -> SqlBoolean 

public function InstanceOf(
    geometryType : String
) : SqlBoolean

Parameters

  • geometryType
    Type: System.String
    A string that specifies one of the 12 types exposed in the geography type hierarchy.

Return Value

Type: System.Data.SqlTypes.SqlBoolean
A SqlBoolean value that indicates whether the SqlGeography instance is the same as the specified geometry type.
Returns true if the type of a geography instance is the same as the specified type, or if the specified type is an ancestor of the instance type; otherwise, returns false.

Remarks

The input for the method must be one of the following: T:Microsoft.SqlServer.Types.SqlGeometry, Point, Curve, LineString, Surface, Polygon, GeometryCollection, MultiSurface, MultiPolygon, MultiCurve, MultiLineString, and MultiPoint.

This method throws an ArgumentException if any other strings are used for the input.