libs/beast/doc/html/beast/ref/boost__beast__http__basic_file_body__value_type/open.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::open</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="is_open.html" title="http::basic_file_body::value_type::is_open">
  10 <link rel="next" href="operator_eq_.html" title="http::basic_file_body::value_type::operator=">
  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="is_open.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="operator_eq_.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.open"></a><a class="link" href="open.html" title="http::basic_file_body::value_type::open">http::basic_file_body::value_type::open</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873503436320"></a>
  31 Open a file at the given path with
  32           the specified mode.
  33         </p>
  34 <h6>
  35 <a name="beast.ref.boost__beast__http__basic_file_body__value_type.open.h0"></a>
  36           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_file_body__value_type.open.synopsis"></a></span><a class="link" href="open.html#beast.ref.boost__beast__http__basic_file_body__value_type.open.synopsis">Synopsis</a>
  37         </h6>
  38 <pre class="programlisting"><span class="keyword">void</span>
  39 <span class="identifier">open</span><span class="special">(</span>
  40     <span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">path</span><span class="special">,</span>
  41     <span class="identifier">file_mode</span> <span class="identifier">mode</span><span class="special">,</span>
  42     <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  43 </pre>
  44 <h6>
  45 <a name="beast.ref.boost__beast__http__basic_file_body__value_type.open.h1"></a>
  46           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_file_body__value_type.open.description"></a></span><a class="link" href="open.html#beast.ref.boost__beast__http__basic_file_body__value_type.open.description">Description</a>
  47         </h6>
  48 <h6>
  49 <a name="beast.ref.boost__beast__http__basic_file_body__value_type.open.h2"></a>
  50           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_file_body__value_type.open.parameters"></a></span><a class="link" href="open.html#beast.ref.boost__beast__http__basic_file_body__value_type.open.parameters">Parameters</a>
  51         </h6>
  52 <div class="informaltable"><table class="table">
  53 <colgroup>
  54 <col>
  55 <col>
  56 </colgroup>
  57 <thead><tr>
  58 <th>
  59                   <p>
  60                     Name
  61                   </p>
  62                 </th>
  63 <th>
  64                   <p>
  65                     Description
  66                   </p>
  67                 </th>
  68 </tr></thead>
  69 <tbody>
  70 <tr>
  71 <td>
  72                   <p>
  73                     <code class="computeroutput"><span class="identifier">path</span></code>
  74                   </p>
  75                 </td>
  76 <td>
  77                   <p>
  78                     The utf-8 encoded path to the file
  79                   </p>
  80                 </td>
  81 </tr>
  82 <tr>
  83 <td>
  84                   <p>
  85                     <code class="computeroutput"><span class="identifier">mode</span></code>
  86                   </p>
  87                 </td>
  88 <td>
  89                   <p>
  90                     The file mode to use
  91                   </p>
  92                 </td>
  93 </tr>
  94 <tr>
  95 <td>
  96                   <p>
  97                     <code class="computeroutput"><span class="identifier">ec</span></code>
  98                   </p>
  99                 </td>
 100 <td>
 101                   <p>
 102                     Set to the error, if any occurred
 103                   </p>
 104                 </td>
 105 </tr>
 106 </tbody>
 107 </table></div>
 108 </div>
 109 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 110 <td align="left"></td>
 111 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 112       Falco<p>
 113         Distributed under the Boost Software License, Version 1.0. (See accompanying
 114         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>)
 115       </p>
 116 </div></td>
 117 </tr></table>
 118 <hr>
 119 <div class="spirit-nav">
 120 <a accesskey="p" href="is_open.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="operator_eq_.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 121 </div>
 122 </body>
 123 </html>