doc/html/boost/property_tree/info_parser/write_info_idp683279952.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Function template write_info</title>
   6 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.info_parser_hpp" title="Header &lt;boost/property_tree/info_parser.hpp&gt;">
  10 <link rel="prev" href="write_info_idp683273648.html" title="Function template write_info">
  11 <link rel="next" href="../ini_parser/ini_parser_error.html" title="Class ini_parser_error">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="write_info_idp683273648.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_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="../ini_parser/ini_parser_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.property_tree.info_parser.write_info_idp683279952"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Function template write_info</span></h2>
  30 <p>boost::property_tree::info_parser::write_info</p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <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.info_parser_hpp" title="Header &lt;boost/property_tree/info_parser.hpp&gt;">boost/property_tree/info_parser.hpp</a>&gt;
  34
  35 </span>
  36 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Ptree<span class="special">&gt;</span>
  37   <span class="keyword">void</span> <span class="identifier">write_info</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="keyword">const</span> <span class="identifier">Ptree</span> <span class="special">&amp;</span> pt<span class="special">,</span>
  38                   <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>
  39                   <span class="keyword">const</span> <span class="identifier">info_writer_settings</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">&gt;</span> <span class="special">&amp;</span> settings <span class="special">=</span> <span class="identifier">info_writer_make_settings</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">&gt;</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div>
  40 <div class="refsect1">
  41 <a name="idp441826288"></a><h2>Description</h2>
  42 <p>Writes a tree to the file in INFO format. The tree's key type must be a string type, i.e. it must have a nested value_type typedef that is a valid parameter for basic_ofstream.
  43
  44 </p>
  45 <div class="variablelist"><table border="0" class="variablelist compact">
  46 <colgroup>
  47 <col align="left" valign="top">
  48 <col>
  49 </colgroup>
  50 <tbody>
  51 <tr>
  52 <td><p><span class="term">Parameters:</span></p></td>
  53 <td><div class="variablelist"><table border="0" class="variablelist compact">
  54 <colgroup>
  55 <col align="left" valign="top">
  56 <col>
  57 </colgroup>
  58 <tbody><tr>
  59 <td><p><span class="term"><code class="computeroutput">settings</code></span></p></td>
  60 <td><p>The settings to use when writing the INFO data. </p></td>
  61 </tr></tbody>
  62 </table></div></td>
  63 </tr>
  64 <tr>
  65 <td><p><span class="term">Throws:</span></p></td>
  66 <td>info_parser_error If the file cannot be written to, or a conversion fails. </td>
  67 </tr>
  68 </tbody>
  69 </table></div>
  70 </div>
  71 </div>
  72 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  73 <td align="left"></td>
  74 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2010 Marcin Kalicinski<br>Copyright &#169; 2010-2013 Sebastian
  75       Redl<p>
  76         Distributed under the Boost Software License, Version 1.0. (See accompanying
  77         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>)
  78       </p>
  79 </div></td>
  80 </tr></table>
  81 <hr>
  82 <div class="spirit-nav">
  83 <a accesskey="p" href="write_info_idp683273648.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.info_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="../ini_parser/ini_parser_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  84 </div>
  85 </body>
  86 </html>