SqlGeometry.Filter Method
Offers a fast, index-only intersection method to determine if a SqlGeometry instance intersects another SqlGeometry instance, assuming an index is available.
Namespace: Microsoft.SqlServer.Types
Assembly: Microsoft.SqlServer.Types (in Microsoft.SqlServer.Types.dll)
Syntax
'Declaration
<SqlMethodAttribute(IsDeterministic := True, IsPrecise := False)> _
Public Function Filter ( _
other As SqlGeometry _
) As SqlBoolean
'Usage
Dim instance As SqlGeometry
Dim other As SqlGeometry
Dim returnValue As SqlBoolean
returnValue = instance.Filter(other)
[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
public SqlBoolean Filter(
SqlGeometry other
)
[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
public:
SqlBoolean Filter(
SqlGeometry^ other
)
[<SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)>]
member Filter :
other:SqlGeometry -> SqlBoolean
public function Filter(
other : SqlGeometry
) : SqlBoolean
Parameters
- other
Type: Microsoft.SqlServer.Types.SqlGeometry
Specifies the SqlGeometry instance to compare to the current SqlGeometry.
Return Value
Type: System.Data.SqlTypes.SqlBoolean
A SqlBoolean that specifies whether the specified SqlGeometry intersects the calling SqlGeometry. If the instances do intersect, this method returns true. Otherwise, it returns false.
Remarks
This method returns true if a SqlGeometry instance potentially intersects another SqlGeometry instance. This method may produce a false positive return, and the exact result may be plan-dependent. Returns an accurate false value (true negative return) if there is no intersection of SqlGeometry instances found.
In cases where an index is not available, or is not used, the method will return the same values as STIntersects when called with the same parameters.