SqlHierarchyId.GetAncestor(Int32) Method

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Types
Assembly:
Microsoft.SqlServer.Types.dll
Package:
Microsoft.SqlServer.DacFx.x64 v140.3881.1
Package:
Microsoft.SqlServer.DacFx v150.5282.3
Package:
Microsoft.SqlServer.DacFx v160.6161.0
Package:
Microsoft.SqlServer.Types v160.1000.6

Retrieves the SqlHierarchyId node n levels up the hierarchical tree.

[Microsoft.SqlServer.Server.SqlMethod(DataAccess=Microsoft.SqlServer.Server.DataAccessKind.None, InvokeIfReceiverIsNull=false, IsDeterministic=true, IsMutator=false, IsPrecise=true, OnNullCall=false, SystemDataAccess=Microsoft.SqlServer.Server.SystemDataAccessKind.None)]
public Microsoft.SqlServer.Types.SqlHierarchyId GetAncestor (int n);
[<Microsoft.SqlServer.Server.SqlMethod(DataAccess=Microsoft.SqlServer.Server.DataAccessKind.None, InvokeIfReceiverIsNull=false, IsDeterministic=true, IsMutator=false, IsPrecise=true, OnNullCall=false, SystemDataAccess=Microsoft.SqlServer.Server.SystemDataAccessKind.None)>]
member this.GetAncestor : int -> Microsoft.SqlServer.Types.SqlHierarchyId
Public Function GetAncestor (n As Integer) As SqlHierarchyId

Parameters

n
Int32

An integer representing the number of levels to ascend in the hierarchy.

Returns

SqlHierarchyId

SqlHierarchyId representing the nth ancestor of this.If a number greater than GetLevel() is passed, null is returned.If a negative number is passed, an exception is raised indicating that the argument is out of range.

Attributes
SqlMethodAttribute

Applies to