RtlSubtreePredecessor function

The RtlSubtreePredecessor routine returns a pointer to the predecessor of the specified node within the subtree that is rooted at that node.

Syntax

NTSYSAPI PRTL_SPLAY_LINKS RtlSubtreePredecessor(
  PRTL_SPLAY_LINKS Links
);

Parameters

Links

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

Return Value

RtlSubtreePredecessor returns a pointer to the subtree predecessor of the node at Links, or NULL if the node has no subtree predecessor.

Remarks

If the node at Links has a left subtree, the rightmost node of that subtree is the subtree predecessor.

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 RtlSubtreePredecessor must be running at IRQL <= DISPATCH_LEVEL if the tree is nonpaged. Usually, callers are running at IRQL PASSIVE_LEVEL.

Requirements

   
Windows version This routine is available on Microsoft Windows 2000 and later.
Target Platform Universal
Header ntddk.h (include Ntddk.h, Ntifs.h)
Library NtosKrnl.lib
DLL NtosKrnl.exe
IRQL See Remarks section.

See Also

RtlInitializeSplayLinks

RtlRealPredecessor

RtlSplay

RtlSubtreeSuccessor