RtlLeftChild macro (ntddk.h)

Article
02/22/2024

The RtlLeftChild routine returns a pointer to the left child of the specified splay link node.

Syntax

void RtlLeftChild(
  [in]  Links
);

Parameters

[in] Links

Pointer to the node whose left child is to be returned. The node must have been initialized by calling RtlInitializeSplayLinks.

Return value

None

Remarks

RtlLeftChild returns a pointer to the left child of the node at Links, or it returns NULL if the specified node has no left child.

RtlLeftChild can be called repeatedly in conjunction with RtlParent and RtlRightChild to walk a splay link tree.

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

Requirements

Requirement	Value
Target Platform	Desktop
Header	ntddk.h (include Ntddk.h, Ntifs.h)
IRQL	See Remarks section.