SqlHierarchyId.CompareTo Method (SqlHierarchyId)

Returns a value indicating the results of a comparison between two SqlHierarchyId nodes.

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

Syntax

'Declaration
Public Function CompareTo ( _
    hid As SqlHierarchyId _
) As Integer
'Usage
Dim instance As SqlHierarchyId
Dim hid As SqlHierarchyId
Dim returnValue As Integer

returnValue = instance.CompareTo(hid)
public int CompareTo(
    SqlHierarchyId hid
)
public:
int CompareTo(
    SqlHierarchyId hid
)
member CompareTo : 
        hid:SqlHierarchyId -> int
public function CompareTo(
    hid : SqlHierarchyId
) : int

Parameters

Return Value

Type: System.Int32
A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:

Value

Meaning

Less than zero

this is less than obj.

Zero

this is equal to obj.

Greater than zero

this is greater than obj.

Remarks

If both SqlHierarchyId nodes are nulla null reference (Nothing in Visual Basic), returns 0.

If one SqlHierarchyId node is nulla null reference (Nothing in Visual Basic), it is considered to be less than the non-nulla null reference (Nothing in Visual Basic) SqlHierarchyId node.

See Also

Reference

SqlHierarchyId Structure

CompareTo Overload

Microsoft.SqlServer.Types Namespace