libs/beast/doc/html/beast/ref/boost__beast__file/open.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>file::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__file.html" title="file">
   9 <link rel="prev" href="native_handle_type.html" title="file::native_handle_type">
  10 <link rel="next" href="pos.html" title="file::pos">
  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="native_handle_type.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__file.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="pos.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__file.open"></a><a class="link" href="open.html" title="file::open">file::open</a>
  28 </h5></div></div></div>
  29 <p>
  30           (Inherited from <code class="computeroutput"><span class="identifier">file_stdio</span></code>)
  31         </p>
  32 <p>
  33           <a class="indexterm" name="idm45873510918720"></a>
  34 Open a file at the given path with the specified mode.
  35         </p>
  36 <h6>
  37 <a name="beast.ref.boost__beast__file.open.h0"></a>
  38           <span class="phrase"><a name="beast.ref.boost__beast__file.open.synopsis"></a></span><a class="link" href="open.html#beast.ref.boost__beast__file.open.synopsis">Synopsis</a>
  39         </h6>
  40 <pre class="programlisting"><span class="keyword">void</span>
  41 <span class="identifier">open</span><span class="special">(</span>
  42     <span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">path</span><span class="special">,</span>
  43     <span class="identifier">file_mode</span> <span class="identifier">mode</span><span class="special">,</span>
  44     <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  45 </pre>
  46 <h6>
  47 <a name="beast.ref.boost__beast__file.open.h1"></a>
  48           <span class="phrase"><a name="beast.ref.boost__beast__file.open.description"></a></span><a class="link" href="open.html#beast.ref.boost__beast__file.open.description">Description</a>
  49         </h6>
  50 <h6>
  51 <a name="beast.ref.boost__beast__file.open.h2"></a>
  52           <span class="phrase"><a name="beast.ref.boost__beast__file.open.parameters"></a></span><a class="link" href="open.html#beast.ref.boost__beast__file.open.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">path</span></code>
  76                   </p>
  77                 </td>
  78 <td>
  79                   <p>
  80                     The utf-8 encoded path to the file
  81                   </p>
  82                 </td>
  83 </tr>
  84 <tr>
  85 <td>
  86                   <p>
  87                     <code class="computeroutput"><span class="identifier">mode</span></code>
  88                   </p>
  89                 </td>
  90 <td>
  91                   <p>
  92                     The file mode to use
  93                   </p>
  94                 </td>
  95 </tr>
  96 <tr>
  97 <td>
  98                   <p>
  99                     <code class="computeroutput"><span class="identifier">ec</span></code>
 100                   </p>
 101                 </td>
 102 <td>
 103                   <p>
 104                     Set to the error, if any occurred
 105                   </p>
 106                 </td>
 107 </tr>
 108 </tbody>
 109 </table></div>
 110 </div>
 111 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 112 <td align="left"></td>
 113 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 114       Falco<p>
 115         Distributed under the Boost Software License, Version 1.0. (See accompanying
 116         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>)
 117       </p>
 118 </div></td>
 119 </tr></table>
 120 <hr>
 121 <div class="spirit-nav">
 122 <a accesskey="p" href="native_handle_type.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__file.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="pos.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 123 </div>
 124 </body>
 125 </html>