[#BitStreamReader-Read]
= xref:BitStreamReader.adoc[BitStreamReader]::Read
:relfileprefix: ../
:mrdocs:

Read the specified number of bits from the stream. The data is returned in the nbits least significant bits of a 64‐bit uint.

== Synopsis

Declared in `<streams.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
uint64_t
Read(int nbits);
----

== Return Value

The bits read, right‐aligned in the low `nbits` bits of the result.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *nbits*
| Number of bits to read, between 0 and 64.
|===


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