RtlSetBits function (wdm.h)

Article
02/22/2024

The RtlSetBits routine sets all bits in a given range of a given bitmap variable.

Syntax

NTSYSAPI VOID RtlSetBits(
  [in] PRTL_BITMAP BitMapHeader,
  [in] ULONG       StartingIndex,
  [in] ULONG       NumberToSet
);

Parameters

[in] BitMapHeader

A pointer to the RTL_BITMAP structure that describes the bitmap. This structure must have been initialized by the RtlInitializeBitMap routine.

[in] StartingIndex

Specifies the start of the bit range to be set. This is a zero-based value indicating the position of the first bit in the range.

[in] NumberToSet

Specifies how many bits to set.

Return value

None

Remarks

RtlSetBits simply returns control if the input NumberToSet is zero. StartingIndex plus NumberToSet must be less than or equal to BitMapHeader->SizeOfBitMap.

Callers of RtlSetBits must be running at IRQL <= APC_LEVEL if the memory that contains the bitmap variable is pageable or the memory at BitMapHeader is pageable. Otherwise, RtlSetBits can be called at any IRQL.

Requirements

Requirement	Value
Minimum supported client	Available starting with Windows 2000.
Target Platform	Universal
Header	wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
Library	NtosKrnl.lib
DLL	NtosKrnl.exe (kernel mode); Ntdll.dll (user mode)
IRQL	<= APC_LEVEL (See Remarks section)