RtlRealSuccessor function

The RtlRealSuccessor routine returns a pointer to the successor of the specified node in the splay link tree.

Syntax

NTSYSAPI PRTL_SPLAY_LINKS RtlRealSuccessor(
  PRTL_SPLAY_LINKS Links
);

Parameters

Links

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

Return Value

RtlRealSuccessor returns a pointer to the successor of the node at Links, or NULL if the node has no successor.

Remarks

The real successor of a given node is determined as follows:

  • If the given node has a right subtree, the leftmost node in the right subtree of the node at Links is the successor. Note that RtlSubtreeSuccessor returns the same result for this case.

  • Otherwise, the nearest ancestor node, of which the given node is a left-subtree descendant, is the successor.

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 RtlRealSuccessor 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

RtlRealPredecessor

RtlSplay

RtlSubtreeSuccessor