RtlTestBit routine

The RtlTestBit routine returns the value of a bit in a bitmap.

Syntax


BOOLEAN RtlTestBit(
  _In_ PRTL_BITMAP BitMapHeader,
  _In_ ULONG       BitNumber
);

Parameters

BitMapHeader [in]

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

BitNumber [in]

Specifies the zero-based index of the bit within the bitmap. The routine returns the value of this bit.

Return value

RtlTestBit returns the value of the bit that the BitNumber parameter points to.

Remarks

Callers of RtlTestBit 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, RtlTestBit can be called at any IRQL.

Requirements

Target platform

Universal

Version

Available in Windows XP and later versions of Windows.

Header

Wdm.h (include Wdm.h, Ntddk.h, or Ntifs.h)

Library

NtosKrnl.lib

DLL

NtosKrnl.exe

IRQL

<= APC_LEVEL (see Remarks section)

See also

RTL_BITMAP
RtlInitializeBitMap

 

 

Send comments about this topic to Microsoft

Show: