RtlCheckBit
TOC
Collapse the table of content
Expand the table of content

RtlCheckBit routine

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

Syntax


ULONG RtlCheckBit(
  _In_ PRTL_BITMAP BitMapHeader,
  _In_ 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

Target platform

Version

Available starting with Windows 2000.

Header

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

IRQL

<= APC_LEVEL (see Remarks section)

See also

RtlAreBitsClear
RtlAreBitsSet
RTL_BITMAP
RtlInitializeBitMap
RtlNumberOfClearBits
RtlNumberOfSetBits

 

 

Send comments about this topic to Microsoft

Show:
© 2016 Microsoft