bitMaskRead

Performs a bitwise mask read operation.
Returns an integer representation of the corresponding bits specified in the mask.

bitMaskRead(number, start, length) → returns numeric

  1. CFDocs
  2. Functions
  3. Math Functions
  4. bitMaskRead
  5. CF
  6. Lucee
  7. 0 Issue
  8. Edit
See Also:   bitMaskClear   bitMaskSet

Argument Reference

number numeric
Required

Integer

start numeric
Required

Start bit for the read mask (Integer in the range 0-31, inclusive)

length numeric
Required

Length of bits in the read mask (Integer in the range 0-31, inclusive)

Examples
Sample code invoking the bitMaskRead function

Uses the bitMaskRead function to read each of the corresponding bits specified in the mask

bitMaskRead(3, 0, 1)

Expected Result: 1

Bit shift the mask 2 places

bitMaskRead(10, 2, 1)

Expected Result: 0

bitMaskRead(10, 1, 3)

Expected Result: 5

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub