RtlInsertAsLeftChild function (ntddk.h)

Article
02/22/2024

The RtlInsertAsLeftChild routine inserts a splay link node into the tree as the left child of the specified node.

Syntax

void RtlInsertAsLeftChild(
  [in] PRTL_SPLAY_LINKS ParentLinks,
  [in] PRTL_SPLAY_LINKS ChildLinks
);

Parameters

[in] ParentLinks

Pointer to the node in the tree at which ChildLinks should be inserted as the left child.

[in] ChildLinks

Pointer to the splay link node to be inserted into the tree. The node must have been initialized by calling RtlInitializeSplayLinks.

Return value

None

Remarks

Callers of RtlInsertAsLeftChild are must meet the following criteria:

The node at ParentLinks must have no left child.
A caller can determine whether the node already has a left child by calling RtlLeftChild. If RtlLeftChild returns NULL, ParentLinks is a valid parameter to RtlInsertAsLeftChild.
The node at ChildLinks must have no parent.
A caller can determine whether this node already has a parent by calling RtlIsRoot or RtlParent. If RtlIsRoot returns TRUE when called with ChildLinks, ChildLinks is a valid parameter to RtlInsertAsLeftChild. If RtlParent returns an equivalent pointer to ChildLinks, ChildLinks is a valid parameter to RtlInsertAsLeftChild.

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 RtlInsertAsLeftChild must be running at IRQL <= DISPATCH_LEVEL if the splay link tree and ChildLinks node are 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.