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

Remove bits from a bit string, shifting higher bits down.

== Synopsis

Declared in `<bdlb_bitstringutil.h>`

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

== Description

Remove the specified `numBits` from the specified `bitString` of the specified `length` beginning at the specified `index`. Bits above `index + numBits` are shifted down by `numBits` index positions and the length of `bitString` is reduced by `numBits`. The values of the vacated high‐order bits are not modified. The behavior is undefined unless `index + numBits <= length`.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *bitString*
| bit string to modify
| *length*
| number of bits in `bitString`
| *index*
| starting bit position of the range to remove
| *numBits*
| number of bits to remove
|===


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