doc/html/boost/property_tree/ini_parser/read_ini_id1160437.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template read_ini</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header &lt;boost/property_tree/ini_parser.hpp&gt;">
   9 <link rel="prev" href="read_ini_id1139273.html" title="Function template read_ini">
  10 <link rel="next" href="write_ini_id1139957.html" title="Function template write_ini">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="read_ini_id1139273.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_ini_id1139957.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.property_tree.ini_parser.read_ini_id1160437"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template read_ini</span></h2>
  29 <p>boost::property_tree::ini_parser::read_ini</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp" title="Header &lt;boost/property_tree/ini_parser.hpp&gt;">boost/property_tree/ini_parser.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Ptree<span class="special">&gt;</span>
  36   <span class="keyword">void</span> <span class="identifier">read_ini</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> filename<span class="special">,</span> <span class="identifier">Ptree</span> <span class="special">&amp;</span> pt<span class="special">,</span>
  37                 <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&amp;</span> loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div>
  38 <div class="refsect1">
  39 <a name="id2600220"></a><h2>Description</h2>
  40 <p>Read INI from a the given file and translate it to a property tree. </p>
  41 <div class="note"><table border="0" summary="Note">
  42 <tr>
  43 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
  44 <th align="left">Note</th>
  45 </tr>
  46 <tr><td align="left" valign="top"><p>Clears existing contents of property tree. In case of error the property tree unmodified. </p></td></tr>
  47 </table></div>
  48 <p>
  49
  50
  51 </p>
  52 <div class="variablelist"><table border="0">
  53 <col align="left" valign="top">
  54 <tbody>
  55 <tr>
  56 <td><p><span class="term">Parameters:</span></p></td>
  57 <td><div class="variablelist"><table border="0">
  58 <col align="left" valign="top">
  59 <tbody>
  60 <tr>
  61 <td><p><span class="term"><code class="computeroutput">filename</code></span></p></td>
  62 <td><p>Name of file from which to read in the property tree. </p></td>
  63 </tr>
  64 <tr>
  65 <td><p><span class="term"><code class="computeroutput">loc</code></span></p></td>
  66 <td><p>The locale to use when reading in the file contents. </p></td>
  67 </tr>
  68 <tr>
  69 <td><p><span class="term"><code class="computeroutput">pt</code></span></p></td>
  70 <td><p>The property tree to populate. </p></td>
  71 </tr>
  72 </tbody>
  73 </table></div></td>
  74 </tr>
  75 <tr>
  76 <td><p><span class="term">Throws:</span></p></td>
  77 <td>
  78 <a class="link" href="ini_parser_error.html" title="Class ini_parser_error">ini_parser_error</a> In case of error deserializing the property tree. </td>
  79 </tr>
  80 </tbody>
  81 </table></div>
  82 </div>
  83 </div>
  84 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  85 <td align="left"></td>
  86 <td align="right"><div class="copyright-footer">Copyright &#169; 2008 Marcin Kalicinski<p>
  87         Distributed under the Boost Software License, Version 1.0. (See accompanying
  88         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  89       </p>
  90 </div></td>
  91 </tr></table>
  92 <hr>
  93 <div class="spirit-nav">
  94 <a accesskey="p" href="read_ini_id1139273.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.ini_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="write_ini_id1139957.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  95 </div>
  96 </body>
  97 </html>