SqlGeography.Filter Method

Offers a fast, index-only intersection method to determine if a geography instance intersects another SqlGeography 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 SqlGeography _
) As SqlBoolean
'Usage
Dim instance As SqlGeography
Dim other As SqlGeography
Dim returnValue As SqlBoolean

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

Parameters

Return Value

Type: System.Data.SqlTypes.SqlBoolean
A SqlBoolean value that specifies whether the specified SqlGeography instance intersects the current SqlGeography.
Returns 1 if a geography instance potentially intersects another SqlGeography instance. This method may produce a false-positive return, and the exact result may be plan-dependent. Returns an accurate 0 value (true negative return) if there is no intersection of SqlGeography instances found.

Remarks

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.

This method is not deterministic and is not precise.