RtlIsLeftChild macro (ntddk.h)

Article
10/21/2021

The RtlIsLeftChild routine determines whether a given splay link is the left child of a node in a splay link tree.

Syntax

void RtlIsLeftChild(
  [in]  Links
);

Parameters

[in] Links

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

Return value

None

Remarks

RtlIsLeftChild returns TRUE if the given node at Links is the left child of its parent node, FALSE otherwise.

The given node at Links must have a parent node in the tree. A caller can determine whether this node has a parent with RtlIsRoot. If RtlIsRoot returns FALSE, Links is a valid parameter to RtlIsLeftChild.

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 RtlIsLeftChild can be running at IRQL <= DISPATCH_LEVEL if the splay link 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.