SqlGeometry.STContains Method

Specifies whether the calling SqlGeometry instance completely contains another SqlGeometry.

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

Syntax

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

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

Parameters

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.