The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
 lang="en" dir="ltr">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <title>
    getline    [C++ Reference]
  </title>

  <meta name="generator" content="DokuWiki Release 2009-12-25c &quot;Lemming&quot;" />
<meta name="robots" content="index,follow" />
<meta name="date" content="2009-10-10T20:36:30-0700" />
<meta name="keywords" content="string,getline" />
<link rel="search" type="application/opensearchdescription+xml" href="/wiki/lib/exe/opensearch.php" title="C++ Reference" />
<link rel="start" href="/wiki/" />
<link rel="contents" href="/wiki/string/getline?do=index" title="Index" />
<link rel="alternate" type="application/rss+xml" title="Recent Changes" href="/wiki/feed.php" />
<link rel="alternate" type="application/rss+xml" title="Current Namespace" href="/wiki/feed.php?mode=list&amp;ns=string" />
<link rel="edit" title="Edit this page" href="/wiki/string/getline?do=edit" />
<link rel="alternate" type="text/html" title="Plain HTML" href="/wiki/_export/xhtml/string/getline" />
<link rel="alternate" type="text/plain" title="Wiki Markup" href="/wiki/_export/raw/string/getline" />
<link rel="canonical" href="http://www.cppreference.com/wiki/string/getline" />
<link rel="stylesheet" media="all" type="text/css" href="/wiki/lib/exe/css.php?s=all&amp;t=custom1&amp;tseed=1272971091" />
<link rel="stylesheet" media="screen" type="text/css" href="/wiki/lib/exe/css.php?t=custom1&amp;tseed=1272971091" />
<link rel="stylesheet" media="print" type="text/css" href="/wiki/lib/exe/css.php?s=print&amp;t=custom1&amp;tseed=1272971091" />
<script type="text/javascript" charset="utf-8" ><!--//--><![CDATA[//><!--
var NS='string';var JSINFO = {"id":"string:getline","namespace":"string"};
//--><!]]></script>
<script type="text/javascript" charset="utf-8" src="/wiki/lib/exe/js.php?tseed=1272971091" ></script>

  <link rel="shortcut icon" href="/wiki/lib/tpl/custom1/images/favicon.png" />

  </head>

<body>
<div class="dokuwiki">
  
  <div class="stylehead">

    <div class="header">
      <div class="pagename">
        [[<a href="../string/getline.html"  title="Backlinks">getline</a>]]
      </div>
      <div class="logo">
        <a href="http://www.cppreference.com"  name="dokuwiki__top" id="dokuwiki__top" accesskey="h" title="[ALT+H]">C++ Reference</a>      </div>

      <div class="clearer"></div>
    </div>

    
    
        <div class="breadcrumbs">
      <span class="bchead">You are here: </span><a href="../start.html"  title="start">C++ Reference</a> &raquo; <a href="../string/start.html"  title="string:start">C++ Strings</a> &raquo; <a href="../string/getline.html"  title="string:getline">getline</a>    </div>
    
  </div>

<div class="plugin_translation"><span>Translations of this page<sup><a href="../localization.html" class="wikilink1" title="localization">?</a></sup>:</span> <ul>  <li><div class="li"><span class="curid"><a href="../string/getline.html" class="wikilink1" title="string:getline">en</a></span></div></li>  <li><div class="li"><a href="../br-pt/string/getline.html" class="wikilink1" title="br-pt:string:getline">br-pt</a></div></li>  <li><div class="li"><a href="../cn/string/getline.html" class="wikilink2" title="cn:string:getline" rel="nofollow">cn</a></div></li>  <li><div class="li"><a href="../cz/string/getline.html" class="wikilink2" title="cz:string:getline" rel="nofollow">cz</a></div></li>  <li><div class="li"><a href="../de/string/getline.html" class="wikilink2" title="de:string:getline" rel="nofollow">de</a></div></li>  <li><div class="li"><a href="../es/string/getline.html" class="wikilink2" title="es:string:getline" rel="nofollow">es</a></div></li>  <li><div class="li"><a href="../fr/string/getline.html" class="wikilink1" title="fr:string:getline">fr</a></div></li>  <li><div class="li"><a href="../it/string/getline.html" class="wikilink2" title="it:string:getline" rel="nofollow">it</a></div></li>  <li><div class="li"><a href="../jp/string/getline.html" class="wikilink1" title="jp:string:getline">jp</a></div></li>  <li><div class="li"><a href="../nl/string/getline.html" class="wikilink2" title="nl:string:getline" rel="nofollow">nl</a></div></li>  <li><div class="li"><a href="../pl/string/getline.html" class="wikilink2" title="pl:string:getline" rel="nofollow">pl</a></div></li>  <li><div class="li"><a href="../ro/string/getline.html" class="wikilink2" title="ro:string:getline" rel="nofollow">ro</a></div></li>  <li><div class="li"><a href="../ru/string/getline.html" class="wikilink2" title="ru:string:getline" rel="nofollow">ru</a></div></li>  <li><div class="li"><a href="../sk/string/getline.html" class="wikilink2" title="sk:string:getline" rel="nofollow">sk</a></div></li>  <li><div class="li"><a href="../tr/string/getline.html" class="wikilink2" title="tr:string:getline" rel="nofollow">tr</a></div></li>  <li><div class="li"><a href="../tw/string/getline.html" class="wikilink2" title="tw:string:getline" rel="nofollow">tw</a></div></li></ul></div>
  
  
  <div class="page">

    <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-2828341-1";
urchinTracker();
</script>
    <!-- wikipage start -->
    


<h2><a name="getline" id="getline">getline</a></h2>
<div class="level2">

<p>
Syntax:
</p>
<pre class="c code c++" style="font-family:monospace;">    <span class="co2">#include &lt;string&gt;</span>
    istream<span class="sy0">&amp;</span> std<span class="sy0">::</span><span class="me2">getline</span><span class="br0">&#40;</span> istream<span class="sy0">&amp;</span> is<span class="sy0">,</span> string<span class="sy0">&amp;</span> s <span class="br0">&#41;</span><span class="sy0">;</span>
    istream<span class="sy0">&amp;</span> std<span class="sy0">::</span><span class="me2">getline</span><span class="br0">&#40;</span> istream<span class="sy0">&amp;</span> is<span class="sy0">,</span> string<span class="sy0">&amp;</span> s<span class="sy0">,</span> Char delimiter <span class="br0">&#41;</span><span class="sy0">;</span></pre>
<p>
The C++ string header defines the global function getline() to read strings from
an I/O stream. The getline() function, which is not part of the string class,
reads a line from is and stores it into s. If a character delimiter is
specified, then getline() will use delimiter to decide when to stop reading
data. Otherwise, call the second form as follows:

</p>
<pre class="c code c++" style="font-family:monospace;"> <span class="kw1">return</span> getline<span class="br0">&#40;</span> is<span class="sy0">,</span> s<span class="sy0">,</span> is.<span class="me1">widen</span><span class="br0">&#40;</span> <span class="st0">'<span class="es1">\n</span>'</span> <span class="br0">&#41;</span> <span class="br0">&#41;</span><span class="sy0">;</span></pre>
<p>
NOTE: <code>istream</code> is the istream type <code>basic_istream&lt;Char&gt;</code> according to the character type.
</p>

<p>
For example, the following code reads a line of text from stdin and displays it
to stdout:
</p>
<pre class="c code c++" style="font-family:monospace;">   <span class="kw4">string</span> s<span class="sy0">;</span>
   getline<span class="br0">&#40;</span> cin<span class="sy0">,</span> s <span class="br0">&#41;</span><span class="sy0">;</span>
   <a href="http://www.opengroup.org/onlinepubs/009695399/functions/cout.html"><span class="kw3">cout</span></a> <span class="sy0">&lt;&lt;</span> <span class="st0">&quot;You entered &quot;</span> <span class="sy0">&lt;&lt;</span> s <span class="sy0">&lt;&lt;</span> endl<span class="sy0">;</span></pre>
<p>
After getting a line of data in a string, you may find that <a href="../io/sstream/start.html" class="wikilink1" title="io:sstream:start">stringstreams</a> are
useful in extracting data from that string. For example, the following code
reads numbers from standard input, ignoring any “commented” lines that begin
with double slashes:
</p>
<pre class="c code c++" style="font-family:monospace;">    <span class="co1">// expects either space-delimited numbers or lines that start with</span>
    <span class="co1">// two forward slashes (//)</span>
    <span class="kw4">string</span> s<span class="sy0">;</span>
    <span class="kw1">while</span><span class="br0">&#40;</span> getline<span class="br0">&#40;</span>cin<span class="sy0">,</span>s<span class="br0">&#41;</span> <span class="br0">&#41;</span> <span class="br0">&#123;</span>
      <span class="kw1">if</span><span class="br0">&#40;</span> s.<span class="me1">size</span><span class="br0">&#40;</span><span class="br0">&#41;</span> <span class="sy0">&gt;=</span> <span class="nu0">2</span> <span class="sy0">&amp;&amp;</span> s<span class="br0">&#91;</span><span class="nu0">0</span><span class="br0">&#93;</span> <span class="sy0">==</span> <span class="st0">'/'</span> <span class="sy0">&amp;&amp;</span> s<span class="br0">&#91;</span><span class="nu0">1</span><span class="br0">&#93;</span> <span class="sy0">==</span> <span class="st0">'/'</span> <span class="br0">&#41;</span> <span class="br0">&#123;</span>
        <a href="http://www.opengroup.org/onlinepubs/009695399/functions/cout.html"><span class="kw3">cout</span></a> <span class="sy0">&lt;&lt;</span> <span class="st0">&quot;  ignoring comment: &quot;</span> <span class="sy0">&lt;&lt;</span> s <span class="sy0">&lt;&lt;</span> endl<span class="sy0">;</span>
      <span class="br0">&#125;</span> <span class="kw1">else</span> <span class="br0">&#123;</span>
        istringstream ss<span class="br0">&#40;</span>s<span class="br0">&#41;</span><span class="sy0">;</span>
        <span class="kw4">double</span> d<span class="sy0">;</span>
        <span class="kw1">while</span><span class="br0">&#40;</span> ss <span class="sy0">&gt;&gt;</span> d <span class="br0">&#41;</span> <span class="br0">&#123;</span>
          <a href="http://www.opengroup.org/onlinepubs/009695399/functions/cout.html"><span class="kw3">cout</span></a> <span class="sy0">&lt;&lt;</span> <span class="st0">&quot;  got a number: &quot;</span> <span class="sy0">&lt;&lt;</span> d <span class="sy0">&lt;&lt;</span> endl<span class="sy0">;</span>
        <span class="br0">&#125;</span>
      <span class="br0">&#125;</span>
    <span class="br0">&#125;</span></pre>
<p>
When run with a user supplying input, the above code might produce this output:
</p>
<pre class="code">
    // test
      ignoring comment: // test
    23.3 -1 3.14159
      got a number: 23.3
      got a number: -1
      got a number: 3.14159
    // next batch
      ignoring comment: // next batch
    1 2 3 4 5
      got a number: 1
      got a number: 2
      got a number: 3
      got a number: 4
      got a number: 5
    50
      got a number: 50</pre>
<p>
Because the getline() function begins reading at the current file position, it can also 
be used to read the remainder of a line, or any characters up to the specified delimiter. 
</p>

<p>
Related Topics: <a href="../io/get.html" class="wikilink1" title="io:get">get</a>, <a href="../io/getline.html" class="wikilink1" title="io:getline">getline</a>, <a href="../io/sstream/start.html" class="wikilink1" title="io:sstream:start">stringstream</a>
</p>

</div>
<div class="secedit"><form class="button btn_secedit" method="post" action="/wiki/string/getline"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="lines" value="3-" /><input type="hidden" name="rev" value="1255232190" /><input type="submit" value="Edit" class="button" title="getline" /></div></form></div>
    <!-- wikipage stop -->
  </div>

  <div class="clearer">&nbsp;</div>

  
  <div class="stylefoot">

    <div class="meta">
      <div class="user">
              </div>
      <!--
      <div class="doc">
        string/getline.txt &middot; Last modified: 10/10/2009 20:36 by 124.255.102.233      </div>
      -->
    </div>

   
    <div class="bar" id="bar__bottom">
      <div class="bar-left" id="bar__bottomleft">
        <a href="../string/getline.html"  class="action edit" accesskey="e" rel="nofollow">Edit this page</a> &#149;
        <a href="../string/getline.html"  class="action revisions" accesskey="o" rel="nofollow">Old revisions</a>      </div>
      <div class="bar-right" id="bar__bottomright">
         &#149;
         &#149;
         &#149;
        <a href="../string/getline.html"  class="action login" rel="nofollow">Login</a> &#149;
        <a href="../string/getline.html"  class="action index" accesskey="x" rel="nofollow">Index</a> &#149;
        <a href="../string/getline.html"  class="action recent" accesskey="r" rel="nofollow">Recent changes</a> &#149;
        <a  href="../feed.php.html" title="Recent changes RSS feed">RSS</a> &#149;
        <a href='http://creativecommons.org/licenses/by/3.0/us/' title='Creative Commons license'>cc</a> &#149;
        <form action="/wiki/" accept-charset="utf-8" class="search" id="dw__search"><div class="no"><input type="hidden" name="do" value="search" /><input type="text" id="qsearch__in" accesskey="f" name="id" class="edit" title="[ALT+F]" /><input type="submit" value="Search" class="button" title="Search" /><div id="qsearch__out" class="ajax_qsearch JSpopup"></div></div></form>&nbsp;
      </div>
      <div class="clearer"></div>
    </div>

  </div>

</div>

<div class="no"><img src="/wiki/lib/exe/indexer.php?id=string%3Agetline&amp;1273195251" width="1" height="1" alt=""  /></div>
</body>
</html>