Edit

RtlDeleteElementGenericTableAvl function (ntddk.h)

  • Article

The RtlDeleteElementGenericTableAvl routine deletes an element from a generic table.

Syntax

NTSYSAPI BOOLEAN RtlDeleteElementGenericTableAvl(
  [in] PRTL_AVL_TABLE Table,
  [in] PVOID          Buffer
);

Parameters

[in] Table

A pointer to the generic table (RTL_AVL_TABLE). The table must have been initialized by calling RtlInitializeGenericTableAvl.

[in] Buffer

A pointer to a caller-allocated buffer containing a value that uniquely identifies the element to be deleted.

Return value

RtlDeleteElementGenericTableAvl returns TRUE if the element was successfully deleted, FALSE otherwise.

Remarks

RtlDeleteElementGenericTableAvl calls the CompareRoutine and FreeRoutine that were registered in the call to RtlInitializeGenericTableAvl.

By default, the operating system uses splay trees to implement generic tables, but the RtlDeleteElementGenericTableAvl routine only works with Adelson-Velsky/Landis (AVL) trees. To configure the generic table routines to use AVL trees instead of splay trees in your driver, insert the following define statement in a common header file before including Ntddk.h:

#define RTL_USE_AVL_TABLES 0

If RTL_USE_AVL_TABLES is not defined, you must use the AVL form of the generic table routines. For example, use the RtlDeleteElementGenericTableAvl routine instead of RtlDeleteElementGenericTable. In the call to RtlDeleteElementGenericTableAvl, the caller must pass a RTL_AVL_TABLE table structure rather than RTL_GENERIC_TABLE.

Callers of the Rtl..GenericTableAvl routines are responsible for exclusively synchronizing access to the generic table. An exclusive fast mutex is the most efficient synchronization mechanism to use for this purpose.

Callers of RtlDeleteElementGenericTableAvl must be running at IRQL < DISPATCH_LEVEL if either of the following conditions holds:

  • The caller-allocated memory at Table or at Buffer is pageable.
  • The caller-supplied CompareRoutine or FreeRoutine contains pageable code.

Requirements

Requirement Value
Minimum supported client Available starting with Windows XP.
Target Platform Universal
Header ntddk.h (include Ntddk.h, Ntifs.h)
Library NtosKrnl.lib
DLL NtosKrnl.exe
IRQL See Remarks section.

See also

RtlInitializeGenericTableAvl

RtlInsertElementGenericTableAvl