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

Extract a length‐prefixed string into the specified `variable`.

== Synopsis

Declared in `<bslx_byteinstream.h>`

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

== Description

Assign to the specified `variable` the string comprised of the length of the string (see `getLength`) and the string data (see `getUint8`), 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.

== Return Value

a reference to this stream

== Parameters

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


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