prepare.html
4.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_streambuf::prepare</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../basic_streambuf.html" title="basic_streambuf">
<link rel="prev" href="overflow.html" title="basic_streambuf::overflow">
<link rel="next" href="reserve.html" title="basic_streambuf::reserve">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overflow.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_streambuf.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="reserve.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.basic_streambuf.prepare"></a><a class="link" href="prepare.html" title="basic_streambuf::prepare">basic_streambuf::prepare</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_streambuf.prepare"></a>
Get a list
of buffers that represents the output sequence, with the given size.
</p>
<pre class="programlisting">mutable_buffers_type prepare(
std::size_t n);
</pre>
<p>
Ensures that the output sequence can accommodate <code class="computeroutput">n</code> characters,
reallocating character array objects as necessary.
</p>
<h6>
<a name="asio.reference.basic_streambuf.prepare.h0"></a>
<span><a name="asio.reference.basic_streambuf.prepare.return_value"></a></span><a class="link" href="prepare.html#asio.reference.basic_streambuf.prepare.return_value">Return Value</a>
</h6>
<p>
An object of type <code class="computeroutput">mutable_buffers_type</code> that satisfies MutableBufferSequence
requirements, representing character array objects at the start of the
output sequence such that the sum of the buffer sizes is <code class="computeroutput">n</code>.
</p>
<h6>
<a name="asio.reference.basic_streambuf.prepare.h1"></a>
<span><a name="asio.reference.basic_streambuf.prepare.exceptions"></a></span><a class="link" href="prepare.html#asio.reference.basic_streambuf.prepare.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">std::length_error</span></dt>
<dd><p>
If <code class="computeroutput">size() + n > max_size()</code>.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_streambuf.prepare.h2"></a>
<span><a name="asio.reference.basic_streambuf.prepare.remarks"></a></span><a class="link" href="prepare.html#asio.reference.basic_streambuf.prepare.remarks">Remarks</a>
</h6>
<p>
The returned object is invalidated by any <code class="computeroutput">basic_streambuf</code>
member function that modifies the input sequence or output sequence.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
Kohlhoff<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overflow.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_streambuf.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="reserve.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>