SqlGeometry.STWithin Method
Determines whether the current SqlGeometry is completely within the specified SqlGeometry instance.
Namespace: Microsoft.SqlServer.Types
Assembly: Microsoft.SqlServer.Types (in Microsoft.SqlServer.Types.dll)
Syntax
'Declaration
<SqlMethodAttribute(IsDeterministic := True, IsPrecise := False)> _
Public Function STWithin ( _
other As SqlGeometry _
) As SqlBoolean
'Usage
Dim instance As SqlGeometry
Dim other As SqlGeometry
Dim returnValue As SqlBoolean
returnValue = instance.STWithin(other)
[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
public SqlBoolean STWithin(
SqlGeometry other
)
[SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)]
public:
SqlBoolean STWithin(
SqlGeometry^ other
)
[<SqlMethodAttribute(IsDeterministic = true, IsPrecise = false)>]
member STWithin :
other:SqlGeometry -> SqlBoolean
public function STWithin(
other : SqlGeometry
) : SqlBoolean
Parameters
- other
Type: Microsoft.SqlServer.Types.SqlGeometry
The SqlGeometry instance to compare to the current SqlGeometry.
Return Value
Type: System.Data.SqlTypes.SqlBoolean
Returns true if a SqlGeometry instance is completely within another SqlGeometry instance; otherwise, returns false.
Remarks
This method always returns nulla null reference (Nothing in Visual Basic) if the spatial reference IDs (SRIDs) of the SqlGeometry instances do not match.