libs/beast/doc/html/beast/ref/boost__beast__http__basic_file_body__value_type/reset.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::basic_file_body::value_type::reset</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../boost__beast__http__basic_file_body__value_type.html" title="http::basic_file_body::value_type">
   9 <link rel="prev" href="operator_eq_.html" title="http::basic_file_body::value_type::operator=">
  10 <link rel="next" href="size.html" title="http::basic_file_body::value_type::size">
  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="operator_eq_.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__basic_file_body__value_type.html"><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="size.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="beast.ref.boost__beast__http__basic_file_body__value_type.reset"></a><a class="link" href="reset.html" title="http::basic_file_body::value_type::reset">http::basic_file_body::value_type::reset</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873503385248"></a>
  31 Set the open file.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__http__basic_file_body__value_type.reset.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_file_body__value_type.reset.synopsis"></a></span><a class="link" href="reset.html#beast.ref.boost__beast__http__basic_file_body__value_type.reset.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">void</span>
  38 <span class="identifier">reset</span><span class="special">(</span>
  39     <span class="identifier">File</span><span class="special">&amp;&amp;</span> <span class="identifier">file</span><span class="special">,</span>
  40     <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  41 </pre>
  42 <h6>
  43 <a name="beast.ref.boost__beast__http__basic_file_body__value_type.reset.h1"></a>
  44           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_file_body__value_type.reset.description"></a></span><a class="link" href="reset.html#beast.ref.boost__beast__http__basic_file_body__value_type.reset.description">Description</a>
  45         </h6>
  46 <p>
  47           This function is used to set the open file. Any previously set file will
  48           be closed.
  49         </p>
  50 <h6>
  51 <a name="beast.ref.boost__beast__http__basic_file_body__value_type.reset.h2"></a>
  52           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_file_body__value_type.reset.parameters"></a></span><a class="link" href="reset.html#beast.ref.boost__beast__http__basic_file_body__value_type.reset.parameters">Parameters</a>
  53         </h6>
  54 <div class="informaltable"><table class="table">
  55 <colgroup>
  56 <col>
  57 <col>
  58 </colgroup>
  59 <thead><tr>
  60 <th>
  61                   <p>
  62                     Name
  63                   </p>
  64                 </th>
  65 <th>
  66                   <p>
  67                     Description
  68                   </p>
  69                 </th>
  70 </tr></thead>
  71 <tbody>
  72 <tr>
  73 <td>
  74                   <p>
  75                     <code class="computeroutput"><span class="identifier">file</span></code>
  76                   </p>
  77                 </td>
  78 <td>
  79                   <p>
  80                     The file to set. The file must be open or else an error occurs
  81                   </p>
  82                 </td>
  83 </tr>
  84 <tr>
  85 <td>
  86                   <p>
  87                     <code class="computeroutput"><span class="identifier">ec</span></code>
  88                   </p>
  89                 </td>
  90 <td>
  91                   <p>
  92                     Set to the error, if any occurred
  93                   </p>
  94                 </td>
  95 </tr>
  96 </tbody>
  97 </table></div>
  98 </div>
  99 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 100 <td align="left"></td>
 101 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 102       Falco<p>
 103         Distributed under the Boost Software License, Version 1.0. (See accompanying
 104         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>)
 105       </p>
 106 </div></td>
 107 </tr></table>
 108 <hr>
 109 <div class="spirit-nav">
 110 <a accesskey="p" href="operator_eq_.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__basic_file_body__value_type.html"><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="size.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 111 </div>
 112 </body>
 113 </html>