SqlHierarchyId.GetDescendant Method

Gets the value of a descendant SqlHierarchyId node that is greater than child1 and less than child2.

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

Syntax

'Declaration
<SqlMethodAttribute(DataAccess := DataAccessKind.None, SystemDataAccess := SystemDataAccessKind.None,  _
    InvokeIfReceiverIsNull := False, OnNullCall := True,  _
    IsDeterministic := True, IsPrecise := True, IsMutator := False)> _
Public Function GetDescendant ( _
    child1 As SqlHierarchyId, _
    child2 As SqlHierarchyId _
) As SqlHierarchyId
'Usage
Dim instance As SqlHierarchyId
Dim child1 As SqlHierarchyId
Dim child2 As SqlHierarchyId
Dim returnValue As SqlHierarchyId

returnValue = instance.GetDescendant(child1, _
    child2)
[SqlMethodAttribute(DataAccess = DataAccessKind.None, SystemDataAccess = SystemDataAccessKind.None, 
    InvokeIfReceiverIsNull = false, OnNullCall = true, 
    IsDeterministic = true, IsPrecise = true, IsMutator = false)]
public SqlHierarchyId GetDescendant(
    SqlHierarchyId child1,
    SqlHierarchyId child2
)
[SqlMethodAttribute(DataAccess = DataAccessKind::None, SystemDataAccess = SystemDataAccessKind::None, 
    InvokeIfReceiverIsNull = false, OnNullCall = true, 
    IsDeterministic = true, IsPrecise = true, IsMutator = false)]
public:
SqlHierarchyId GetDescendant(
    SqlHierarchyId child1, 
    SqlHierarchyId child2
)
[<SqlMethodAttribute(DataAccess = DataAccessKind.None, SystemDataAccess = SystemDataAccessKind.None, 
    InvokeIfReceiverIsNull = false, OnNullCall = true, 
    IsDeterministic = true, IsPrecise = true, IsMutator = false)>]
member GetDescendant : 
        child1:SqlHierarchyId * 
        child2:SqlHierarchyId -> SqlHierarchyId
public function GetDescendant(
    child1 : SqlHierarchyId, 
    child2 : SqlHierarchyId
) : SqlHierarchyId

Parameters

Return Value

Type: Microsoft.SqlServer.Types.SqlHierarchyId
A SqlHierarchyId with a value greater than the lower bound and less than the upper bound.

Remarks

  • If parent is nulla null reference (Nothing in Visual Basic), returns nulla null reference (Nothing in Visual Basic).

  • If parent is not nulla null reference (Nothing in Visual Basic), and both child1 and child2 are nulla null reference (Nothing in Visual Basic), returns a descendant of parent.

  • If parent and child1 are not nulla null reference (Nothing in Visual Basic), and child2 is nulla null reference (Nothing in Visual Basic), returns a descendant of parent greater than child1.

  • If parent and child2 are not nulla null reference (Nothing in Visual Basic) and child1 is nulla null reference (Nothing in Visual Basic), returns a descendant of parent less than child2.

  • If parent, child1, and child2 are not nulla null reference (Nothing in Visual Basic), returns a descendant of parent greater than child1 and less than child2.

  • An exception is raised if child1 or child2 are not nulla null reference (Nothing in Visual Basic) and are not a descendant of parent.

  • If child1 >= child2, an exception is raised.

See Also

Reference

SqlHierarchyId Structure

Microsoft.SqlServer.Types Namespace