RtlCheckBit macro

The RtlCheckBit routine determines whether a particular bit in a given bitmap variable is clear or set.

Syntax

BOOLEAN RtlCheckBit(
  PRTL_BITMAP BitMapHeader,
  ULONG       BitPosition
);

Parameters

BitMapHeader

[in]

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

BitPosition

[in]

Specifies which bit to check. This is a zero-based value indicating the position of the bit to be tested.

Return value

RtlCheckBit returns zero if the given bit is clear, or one if the given bit is set.

Remarks

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

Requirements

   
Minimum supported client Available starting with Windows 2000.
Target Platform Desktop
Header wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
IRQL <= APC_LEVEL (see Remarks section)

See also

RTL_BITMAP

RtlAreBitsClear

RtlAreBitsSet

RtlInitializeBitMap

RtlNumberOfClearBits

RtlNumberOfSetBits