SqlGeometry.STRelate Method (SqlGeometry, String)


Determines whether the calling SqlGeometry is related to the specified SqlGeometry.

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

[<SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)>]
member STRelate : 
        other:SqlGeometry *
        intersectionPatternMatrix:string -> SqlBoolean


Type: Microsoft.SqlServer.Types.SqlGeometry

Is another SqlGeometry instance to compare against the instance on which STRelate is invoked.

Type: System.String

A string that specifies the intersection model. This string must contain acceptable values for the DE-9IM pattern matrix device between the two SqlGeometry instances.

Return Value

Type: System.Data.SqlTypes.SqlBoolean

Returns true if a SqlGeometry instance is related to another SqlGeometry instance, where the relationship is defined by a Dimensionally Extended 9 Intersection Model (DE-9IM) pattern matrix value; otherwise, returns false.

This method always returns null if the spatial reference IDs (SRIDs) of the SqlGeometry instances do not match. This method will throw an ArgumentException if the matrix is not well-formed.

Return to top