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