[#bsl-basic_istringstream-getline-01]
= xref:bsl.adoc[bsl]::xref:bsl/basic_istringstream.adoc[basic_istringstream]::getline
:relfileprefix: ../../
:mrdocs:

`getline` overloads

== Synopses

Declared in `<bslstl_istringstream.h>`

String extraction.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
__istream_type&
xref:bsl/basic_istringstream/getline-0a9.adoc[getline](
    char_type* __s,
    streamsize __n);
----

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

Extract a line of characters into `buffer`.


[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_type]* buffer,
    std::streamsize count);
----

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

String extraction.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
__istream_type&
xref:bsl/basic_istringstream/getline-04.adoc[getline](
    char_type* __s,
    streamsize __n,
    char_type __delim);
----

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

Extract characters into `buffer` until `delimiter`.


[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_type]* buffer,
    std::streamsize count,
    xref:bsl/basic_istringstream/char_type.adoc[char_type] delimiter);
----

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

== Return Value

* *this
* a reference to this stream

== Parameters

[cols="1,4"]
|===
| Name| Description
| *__s*
| A character array in which to store the data.
| *__n*
| Maximum number of characters to extract.
| *buffer*
| destination character array
| *count*
| maximum number of characters to store
| *__delim*
| A "stop" character.
| *delimiter*
| character that stops extraction
|===


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