Previous Next

RtlCheckBit

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

ULONG
  RtlCheckBit(
    IN PRTL_BITMAP  BitMapHeader,
    IN ULONG  BitPosition
    ); 

Parameters

BitMapHeader
Pointer to an initialized bitmap header for the caller's bitmap variable.
BitPosition
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 1 if the given bit is set.

Headers

Declared in ntddk.h. Include ntddk.h.

Comments

Callers of RtlCheckBit must be running at IRQL < DISPATCH_LEVEL if the memory containing the bitmap variable or at BitMapHeader is pageable. Otherwise, RtlCheckBit can be called at any IRQL.

See Also

RtlAreBitsClear, RtlAreBitsSet, RtlInitializeBitMap, RtlNumberOfClearBits, RtlNumberOfSetBits