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

Read characters from a stream into a string.

== Synopses

Declared in `<bslstl_string.h>`

Read characters from a stream into a string.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class CHAR_TYPE,
    class CHAR_TRAITS,
    class ALLOCATOR>
std::basic_istream<CHAR_TYPE, CHAR_TRAITS>&
xref:bsl/getline-0a.adoc[getline](
    std::basic_istream<CHAR_TYPE, CHAR_TRAITS>& is,
    xref:bsl/basic_string-0faf.adoc[basic_string<CHAR_TYPE, CHAR_TRAITS, ALLOCATOR>]& str);
----

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

Read characters from a stream into a string.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class CHAR_TYPE,
    class CHAR_TRAITS,
    class ALLOCATOR>
std::basic_istream<CHAR_TYPE, CHAR_TRAITS>&
xref:bsl/getline-04.adoc[getline](
    std::basic_istream<CHAR_TYPE, CHAR_TRAITS>& is,
    xref:bsl/basic_string-0faf.adoc[basic_string<CHAR_TYPE, CHAR_TRAITS, ALLOCATOR>]& str,
    CHAR_TYPE delim);
----

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

== Return Value

reference to the input stream `is`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *is*
| input stream
| *str*
| string to read into or parse
| *delim*
| delimiter character ending the extraction
|===


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