[#BloombergLP-bdlb-BitStringUtil-bits]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlb.adoc[bdlb]::xref:BloombergLP/bdlb/BitStringUtil.adoc[BitStringUtil]::bits
:relfileprefix: ../../../
:mrdocs:

Return a range of bits from `bitString` as an integer.

== Synopsis

Declared in `<bdlb_bitstringutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
uint64_t
bits(
    uint64_t const* bitString,
    std::size_t index,
    std::size_t numBits);
----

== Description

Return the specified `numBits` beginning at the specified `index` in the specified `bitString` as the low‐order bits of the returned value. The behavior is undefined unless `numBits <= k_BITS_PER_UINT64` and `bitString` has a length of at least `index + numBits`.

== Return Value

the selected bits as the low‐order bits of the result

== Parameters

[cols="1,4"]
|===
| Name| Description
| *bitString*
| bit string to read
| *index*
| starting bit position
| *numBits*
| number of bits to return
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#