[#bsl-basic_istringstream-get-00]
= xref:bsl.adoc[bsl]::xref:bsl/basic_istringstream.adoc[basic&lowbar;istringstream]::get
:relfileprefix: ../../
:mrdocs:

Simple multiple&hyphen;character extraction&period;

== Synopsis

Declared in `&lt;bslstl&lowbar;istringstream&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
&lowbar;&lowbar;istream&lowbar;type&
get(
    char&lowbar;type* &lowbar;&lowbar;s,
    streamsize &lowbar;&lowbar;n,
    char&lowbar;type &lowbar;&lowbar;delim);
----

== Description

Characters are extracted and stored into _&lowbar;&lowbar;s_ until one of the following happens&colon;

* `&lowbar;&lowbar;n&hyphen;1` characters are stored
* the input sequence reaches EOF
* the next character equals _&lowbar;&lowbar;delim,_ in which case the character is not extracted

If no characters are stored, failbit is set in the stream&apos;s error state&period;

In any case, a null character is stored into the next location in the array&period;

[NOTE]
====
This function is not overloaded on signed char and unsigned char&period;

====

== Return Value

&ast;this

== Parameters

[cols="1,4"]
|===
| Name| Description
| *&lowbar;&lowbar;s*
| Pointer to an array&period;
| *&lowbar;&lowbar;n*
| Maximum number of characters to store in _&lowbar;&lowbar;s&period;_
| *&lowbar;&lowbar;delim*
| A &quot;stop&quot; character&period;
|===


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