[#BloombergLP-bslx-ByteInStream-getUint24]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslx.adoc[bslx]::xref:BloombergLP/bslx/ByteInStream.adoc[ByteInStream]::getUint24
:relfileprefix: ../../../
:mrdocs:

Assign the next three&hyphen;byte unsigned integer to `variable`&period;

== Synopsis

Declared in `&lt;bslx&lowbar;byteinstream&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bslx/ByteInStream.adoc[ByteInStream]&
getUint24(unsigned int& variable);
----

== Description

Assign to the specified `variable` the three&hyphen;byte, two&apos;s complement unsigned integer (in host byte order) comprised of the three bytes of this stream at the current cursor location (in network byte order), update the cursor location, and return a reference to this stream&period; If this stream is initially invalid, this operation has no effect&period; If this function otherwise fails to extract a valid value, this stream is marked invalid and the value of `variable` is undefined&period; Note that the value will be zero&hyphen;extended&period;

== Return Value

a reference to this stream

== Parameters

[cols="1,4"]
|===
| Name| Description
| *variable*
| destination for the extracted value
|===


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