[#BloombergLP-bslx-GenericInStream-getUint16]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslx.adoc[bslx]::xref:BloombergLP/bslx/GenericInStream.adoc[GenericInStream]::getUint16
:relfileprefix: ../../../
:mrdocs:

Read a 16‐bit unsigned integer into `variable`.

== Synopsis

Declared in `<bslx_genericinstream.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bslx/GenericInStream.adoc[GenericInStream<STREAMBUF>]&
getUint16(unsigned short& variable);
----

== Description

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

== Return Value

a reference to this input stream

== Parameters

[cols="1,4"]
|===
| Name| Description
| *variable*
| receives the value in host byte order
|===


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