RtlIsRoot routine

The RtlIsRoot routine determines whether the specified node is the root node of a splay link tree.

Syntax


BOOLEAN RtlIsRoot(
  _In_ PRTL_SPLAY_LINKS Links
);

Parameters

Links [in]

Pointer to the node. The node must have been initialized by calling RtlInitializeSplayLinks.

Return value

RtlIsRoot returns TRUE if the node at Links has no parent node, FALSE otherwise.

Remarks

Callers of the Rtl splay link routines are responsible for synchronizing access to the splay link tree. A fast mutex is the most efficient synchronization mechanism to use for this purpose.

Callers of RtlIsRoot must be running at IRQL <= DISPATCH_LEVEL if the splay link tree or just-initialized node at Links is nonpaged. Usually, callers are running at IRQL PASSIVE_LEVEL.

Requirements

Target platform

Desktop

Header

Ntddk.h (include Ntddk.h or Ntifs.h)

IRQL

See Remarks section.

See also

RtlInitializeSplayLinks
RtlIsLeftChild
RtlIsRightChild

 

 

Send comments about this topic to Microsoft

Show: