SqlGeometry.STOverlaps Method

Determines whether the specified SqlGeometry overlaps the current SqlGeometry.

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

Syntax

'Declaration
<SqlMethodAttribute(IsDeterministic := True, IsPrecise := False)> _
Public Function STOverlaps ( _
    other As SqlGeometry _
) As SqlBoolean
'Usage
Dim instance As SqlGeometry
Dim other As SqlGeometry
Dim returnValue As SqlBoolean

returnValue = instance.STOverlaps(other)
[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
public SqlBoolean STOverlaps(
    SqlGeometry other
)
[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
public:
SqlBoolean STOverlaps(
    SqlGeometry^ other
)
[<SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)>]
member STOverlaps : 
        other:SqlGeometry -> SqlBoolean 
public function STOverlaps(
    other : SqlGeometry
) : SqlBoolean

Parameters

Return Value

Type: System.Data.SqlTypes.SqlBoolean
Returns true if a SqlGeometry instance overlaps another SqlGeometry instance. Returns false if it does not.

Remarks

Two SqlGeometry instances overlap if the region that represents their intersection has the same dimension as the instances do, and the instances are not equal.

STOverlaps always returns false if the points where the geometry instances intersect are not the same dimension.

This method always returns null if the spatial reference IDs (SRIDs) of the SqlGeometry instances do not match.