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

`getline` overloads

== Synopses

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

String extraction&period;


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
&lowbar;&lowbar;istream&lowbar;type&
xref:bsl/basic_istringstream/getline-0a9.adoc[getline](
    char&lowbar;type* &lowbar;&lowbar;s,
    streamsize &lowbar;&lowbar;n);
----

[.small]#xref:bsl/basic_istringstream/getline-0a9.adoc[_» more&period;&period;&period;_]#

Extract a line of characters into `buffer`&period;


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bsl/basic_istringstream.adoc[BaseStream]&
xref:bsl/basic_istringstream/getline-06.adoc[getline](
    xref:bsl/basic_istringstream/char_type.adoc[char&lowbar;type]* buffer,
    std::streamsize count);
----

[.small]#xref:bsl/basic_istringstream/getline-06.adoc[_» more&period;&period;&period;_]#

String extraction&period;


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
&lowbar;&lowbar;istream&lowbar;type&
xref:bsl/basic_istringstream/getline-04.adoc[getline](
    char&lowbar;type* &lowbar;&lowbar;s,
    streamsize &lowbar;&lowbar;n,
    char&lowbar;type &lowbar;&lowbar;delim);
----

[.small]#xref:bsl/basic_istringstream/getline-04.adoc[_» more&period;&period;&period;_]#

Extract characters into `buffer` until `delimiter`&period;


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bsl/basic_istringstream.adoc[BaseStream]&
xref:bsl/basic_istringstream/getline-0a3.adoc[getline](
    xref:bsl/basic_istringstream/char_type.adoc[char&lowbar;type]* buffer,
    std::streamsize count,
    xref:bsl/basic_istringstream/char_type.adoc[char&lowbar;type] delimiter);
----

[.small]#xref:bsl/basic_istringstream/getline-0a3.adoc[_» more&period;&period;&period;_]#

== Return Value

* &ast;this
* a reference to this stream

== Parameters

[cols="1,4"]
|===
| Name| Description
| *&lowbar;&lowbar;s*
| A character array in which to store the data&period;
| *&lowbar;&lowbar;n*
| Maximum number of characters to extract&period;
| *buffer*
| destination character array
| *count*
| maximum number of characters to store
| *&lowbar;&lowbar;delim*
| A &quot;stop&quot; character&period;
| *delimiter*
| character that stops extraction
|===


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