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

Return the bit value at the specified `index` in `bitString`.

== Synopsis

Declared in `<bdlb_bitstringutil.h>`

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

== Description

Return the bit value at the specified `index` in the specified `bitString`. The behavior is undefined unless `index` is less than the length of `bitString`.

== Return Value

value of the bit at `index`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *bitString*
| bit string to read
| *index*
| bit position to read
|===


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