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

Read the specified number of bits from the stream&period; The data is returned in the nbits least significant bits of a 64&hyphen;bit uint&period;

== Synopsis

Declared in `&lt;streams&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
uint64&lowbar;t
Read(int nbits);
----

== Return Value

The bits read, right&hyphen;aligned in the low `nbits` bits of the result&period;

== Parameters

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


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