SqlHierarchyId Struct

Definition

The SqlHierarchyId type represents a position in a hierarchical structure, specifying depth and breadth.

[Microsoft.SqlServer.Server.SqlUserDefinedType(Microsoft.SqlServer.Server.Format.UserDefined, IsByteOrdered=true, MaxByteSize=892, Name="SqlHierarchyId")]
[System.CLSCompliant(true)]
public struct SqlHierarchyId : IComparable, Microsoft.SqlServer.Server.IBinarySerialize, System.Data.SqlTypes.INullable
[<Microsoft.SqlServer.Server.SqlUserDefinedType(Microsoft.SqlServer.Server.Format.UserDefined, IsByteOrdered=true, MaxByteSize=892, Name="SqlHierarchyId")>]
[<System.CLSCompliant(true)>]
type SqlHierarchyId = struct
    interface IBinarySerialize
    interface INullable
Public Structure SqlHierarchyId
Implements IBinarySerialize, IComparable, INullable
Inheritance
SqlHierarchyId
Attributes
Implements

Properties

IsNull

Gets a value indicating whether the SqlHierarchyId is null.

Null

Gets a SqlHierarchyId with a hierarchy identification of null.

Methods

CompareTo(Object)

Returns a value indicating the results of a comparison between a SqlHierarchyId and an object.

CompareTo(SqlHierarchyId)

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

Equals(Object)

Evaluates whether SqlHierarchyId and obj are equal.

GetAncestor(Int32)

Retrieves the SqlHierarchyId node n levels up the hierarchical tree.

GetDescendant(SqlHierarchyId, SqlHierarchyId)

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

GetHashCode()

Gets a hash of the path from the root node of the hierarchy tree to the SqlHierarchyId node.

GetLevel()

Gets a value indicating the level of the SqlHierarchyId node in the hierarchical tree.

GetReparentedValue(SqlHierarchyId, SqlHierarchyId)

Gets a value representing the location of a new SqlHierarchyId node that has a path from newRoot equal to the path from oldRoot to this, effectively moving this to the new location.

GetRoot()

Gets a value representing the root SqlHierarchyId node of the hierarchy.

IsDescendantOf(SqlHierarchyId)

Gets a value indicating whether the SqlHierarchyId node is the descendant of the parent.

Parse(SqlString)

Converts the canonical string representation of a SqlHierarchyId node to a SqlHierarchyId value.

Read(BinaryReader)

Reads from a specified binary reader into a SqlHierarchyId.

ToString()

Returns the canonical string representation of a SqlHierarchyId node from a SqlHierarchyId value.

Write(BinaryWriter)

Writes a SqlHierarchyId to a specified binary writer.

Operators

Equality(SqlHierarchyId, SqlHierarchyId)

Evaluates whether two SqlHierarchyId nodes are equal.

GreaterThan(SqlHierarchyId, SqlHierarchyId)

Evaluates whether one specified SqlHierarchyId node is greater than another.

GreaterThanOrEqual(SqlHierarchyId, SqlHierarchyId)

Evaluates whether one specified SqlHierarchyId node is greater than or equal to another.

Inequality(SqlHierarchyId, SqlHierarchyId)

Evaluates whether two SqlHierarchyId nodes are unequal.

LessThan(SqlHierarchyId, SqlHierarchyId)

Evaluates whether one specified SqlHierarchyId node is less than another.

LessThanOrEqual(SqlHierarchyId, SqlHierarchyId)

Evaluates whether one specified SqlHierarchyId node is less than or equal to another.

Applies to