RtlSubtreeSuccessor function (ntddk.h)
The RtlSubtreeSuccessor routine returns a pointer to the successor of the specified node within the subtree that is rooted at that node.
Syntax
NTSYSAPI PRTL_SPLAY_LINKS RtlSubtreeSuccessor(
[in] PRTL_SPLAY_LINKS Links
);
Parameters
[in] Links
A pointer to the node. The node must have been initialized by calling RtlInitializeSplayLinks.
Return value
RtlSubtreeSuccessor returns a pointer to the subtree successor of the node at Links, or NULL if the given node has no subtree successor.
Remarks
If the node at Links has a right subtree, the leftmost node of that subtree is the subtree 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 RtlSubtreeSuccessor must be running at IRQL <= DISPATCH_LEVEL if the tree is nonpaged. If the tree is paged, callers must be running at IRQL < DISPATCH_LEVEL. Usually callers are running at IRQL PASSIVE_LEVEL.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | 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. |