• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>file::read</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 1. Boost.Beast">
8<link rel="up" href="../boost__beast__file.html" title="file">
9<link rel="prev" href="seek.html" title="file::seek">
10<link rel="next" href="write.html" title="file::write">
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="seek.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="write.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.read"></a><a class="link" href="read.html" title="file::read">file::read</a>
28</h5></div></div></div>
29<p>
30          <a class="indexterm" name="idm46057539127184"></a>
31        </p>
32<p>
33          (Inherited from <a class="link" href="../boost__beast__file_stdio.html" title="file_stdio"><code class="computeroutput"><span class="identifier">file_stdio</span></code></a>)
34        </p>
35<p>
36          Read from the open file.
37        </p>
38<h6>
39<a name="beast.ref.boost__beast__file.read.h0"></a>
40          <span class="phrase"><a name="beast.ref.boost__beast__file.read.synopsis"></a></span><a class="link" href="read.html#beast.ref.boost__beast__file.read.synopsis">Synopsis</a>
41        </h6>
42<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
43<span class="identifier">read</span><span class="special">(</span>
44    <span class="keyword">void</span><span class="special">*</span> <span class="identifier">buffer</span><span class="special">,</span>
45    <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">n</span><span class="special">,</span>
46    <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
47</pre>
48<h6>
49<a name="beast.ref.boost__beast__file.read.h1"></a>
50          <span class="phrase"><a name="beast.ref.boost__beast__file.read.description"></a></span><a class="link" href="read.html#beast.ref.boost__beast__file.read.description">Description</a>
51        </h6>
52<h6>
53<a name="beast.ref.boost__beast__file.read.h2"></a>
54          <span class="phrase"><a name="beast.ref.boost__beast__file.read.parameters"></a></span><a class="link" href="read.html#beast.ref.boost__beast__file.read.parameters">Parameters</a>
55        </h6>
56<div class="informaltable"><table class="table">
57<colgroup>
58<col>
59<col>
60</colgroup>
61<thead><tr>
62<th>
63                  <p>
64                    Name
65                  </p>
66                </th>
67<th>
68                  <p>
69                    Description
70                  </p>
71                </th>
72</tr></thead>
73<tbody>
74<tr>
75<td>
76                  <p>
77                    <code class="computeroutput"><span class="identifier">buffer</span></code>
78                  </p>
79                </td>
80<td>
81                  <p>
82                    The buffer for storing the result of the read
83                  </p>
84                </td>
85</tr>
86<tr>
87<td>
88                  <p>
89                    <code class="computeroutput"><span class="identifier">n</span></code>
90                  </p>
91                </td>
92<td>
93                  <p>
94                    The number of bytes to read
95                  </p>
96                </td>
97</tr>
98<tr>
99<td>
100                  <p>
101                    <code class="computeroutput"><span class="identifier">ec</span></code>
102                  </p>
103                </td>
104<td>
105                  <p>
106                    Set to the error, if any occurred
107                  </p>
108                </td>
109</tr>
110</tbody>
111</table></div>
112</div>
113<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
114<td align="left"></td>
115<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
116      Falco<p>
117        Distributed under the Boost Software License, Version 1.0. (See accompanying
118        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>)
119      </p>
120</div></td>
121</tr></table>
122<hr>
123<div class="spirit-nav">
124<a accesskey="p" href="seek.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="write.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
125</div>
126</body>
127</html>
128