SqlGeometry.STContains Method (SqlGeometry)

Applies To: SQL Server 2016 Preview

Specifies whether the calling SqlGeometry instance completely contains another SqlGeometry.

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

Syntax

[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
public SqlBoolean STContains(
    SqlGeometry other
)

public:
[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
SqlBoolean STContains(
    SqlGeometry^ other
)

[<SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)>]
member STContains : 
        other:SqlGeometry -> SqlBoolean

<SqlMethodAttribute(IsDeterministic := True, IsPrecise := False)>
Public Function STContains (
    other As SqlGeometry
) As SqlBoolean

Parameters

• other
  Type: Microsoft.SqlServer.Types.SqlGeometry

  The SqlGeometry instance to compare against the instance on which STContains is invoked.

Return Value

Type: System.Data.SqlTypes.SqlBoolean

Returns true if a SqlGeometry instance completely contains another SqlGeometry instance. Otherwise, returns false.

Remarks

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

See Also

SqlGeometry Class
Microsoft.SqlServer.Types Namespace

Return to top