doc/html/boost_asio/reference/dynamic_string_buffer/prepare.html


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
80
81
82
83
84
85
86
87

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>dynamic_string_buffer::prepare</title>
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../dynamic_string_buffer.html" title="dynamic_string_buffer">
<link rel="prev" href="mutable_buffers_type.html" title="dynamic_string_buffer::mutable_buffers_type">
<link rel="next" href="size.html" title="dynamic_string_buffer::size">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="mutable_buffers_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../dynamic_string_buffer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="size.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.dynamic_string_buffer.prepare"></a><a class="link" href="prepare.html" title="dynamic_string_buffer::prepare">dynamic_string_buffer::prepare</a>
</h4></div></div></div>
<p>
          <a class="indexterm" name="boost_asio.indexterm.dynamic_string_buffer.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> bytes,
          resizing the basic_string object as necessary.
        </p>
<h6>
<a name="boost_asio.reference.dynamic_string_buffer.prepare.h0"></a>
          <span class="phrase"><a name="boost_asio.reference.dynamic_string_buffer.prepare.return_value"></a></span><a class="link" href="prepare.html#boost_asio.reference.dynamic_string_buffer.prepare.return_value">Return
          Value</a>
        </h6>
<p>
          An object of type <code class="computeroutput">mutable_buffers_type</code> that satisfies MutableBufferSequence
          requirements, representing basic_string memory at the start of the output
          sequence of size <code class="computeroutput">n</code>.
        </p>
<h6>
<a name="boost_asio.reference.dynamic_string_buffer.prepare.h1"></a>
          <span class="phrase"><a name="boost_asio.reference.dynamic_string_buffer.prepare.exceptions"></a></span><a class="link" href="prepare.html#boost_asio.reference.dynamic_string_buffer.prepare.exceptions">Exceptions</a>
        </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">std::length_error</span></dt>
<dd><p>
                If <code class="computeroutput">size() + n &gt; max_size()</code>.
              </p></dd>
</dl>
</div>
<h6>
<a name="boost_asio.reference.dynamic_string_buffer.prepare.h2"></a>
          <span class="phrase"><a name="boost_asio.reference.dynamic_string_buffer.prepare.remarks"></a></span><a class="link" href="prepare.html#boost_asio.reference.dynamic_string_buffer.prepare.remarks">Remarks</a>
        </h6>
<p>
          The returned object is invalidated by any <code class="computeroutput">dynamic_string_buffer</code>
          or <code class="computeroutput">basic_string</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 &#169; 2003-2017 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="mutable_buffers_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../dynamic_string_buffer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="size.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>