• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>buffer_cast</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="../../boost_asio.html" title="Boost.Asio">
8<link rel="up" href="../reference.html" title="Reference">
9<link rel="prev" href="buffer/overload32.html" title="buffer (32 of 32 overloads)">
10<link rel="next" href="buffer_cast/overload1.html" title="buffer_cast (1 of 2 overloads)">
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="buffer/overload32.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="buffer_cast/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h3 class="title">
27<a name="boost_asio.reference.buffer_cast"></a><a class="link" href="buffer_cast.html" title="buffer_cast">buffer_cast</a>
28</h3></div></div></div>
29<p>
30        <a class="indexterm" name="boost_asio.indexterm.buffer_cast"></a>
31(Deprecated: Use the <code class="computeroutput">data()</code>
32        member function.) The <code class="computeroutput">boost::asio::buffer_cast</code> function is used
33        to obtain a pointer to the underlying memory region associated with a buffer.
34      </p>
35<p>
36        Cast a non-modifiable buffer to a specified pointer to POD type.
37      </p>
38<pre class="programlisting">template&lt;
39    typename PointerToPodType&gt;
40PointerToPodType <a class="link" href="buffer_cast/overload1.html" title="buffer_cast (1 of 2 overloads)">buffer_cast</a>(
41    const mutable_buffer &amp; b);
42  <span class="emphasis"><em>» <a class="link" href="buffer_cast/overload1.html" title="buffer_cast (1 of 2 overloads)">more...</a></em></span>
43
44template&lt;
45    typename PointerToPodType&gt;
46PointerToPodType <a class="link" href="buffer_cast/overload2.html" title="buffer_cast (2 of 2 overloads)">buffer_cast</a>(
47    const const_buffer &amp; b);
48  <span class="emphasis"><em>» <a class="link" href="buffer_cast/overload2.html" title="buffer_cast (2 of 2 overloads)">more...</a></em></span>
49</pre>
50<h5>
51<a name="boost_asio.reference.buffer_cast.h0"></a>
52        <span class="phrase"><a name="boost_asio.reference.buffer_cast.examples_"></a></span><a class="link" href="buffer_cast.html#boost_asio.reference.buffer_cast.examples_">Examples:</a>
53      </h5>
54<p>
55        To access the memory of a non-modifiable buffer, use:
56      </p>
57<pre class="programlisting">boost::asio::const_buffer b1 = ...;
58const unsigned char* p1 = boost::asio::buffer_cast&lt;const unsigned char*&gt;(b1);
59</pre>
60<p>
61        To access the memory of a modifiable buffer, use:
62      </p>
63<pre class="programlisting">boost::asio::mutable_buffer b2 = ...;
64unsigned char* p2 = boost::asio::buffer_cast&lt;unsigned char*&gt;(b2);
65</pre>
66<p>
67        The <code class="computeroutput">boost::asio::buffer_cast</code> function permits violations of
68        type safety, so uses of it in application code should be carefully considered.
69      </p>
70<h5>
71<a name="boost_asio.reference.buffer_cast.h1"></a>
72        <span class="phrase"><a name="boost_asio.reference.buffer_cast.requirements"></a></span><a class="link" href="buffer_cast.html#boost_asio.reference.buffer_cast.requirements">Requirements</a>
73      </h5>
74<p>
75        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/buffer.hpp</code>
76      </p>
77<p>
78        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
79      </p>
80</div>
81<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
82<td align="left"></td>
83<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
84      Kohlhoff<p>
85        Distributed under the Boost Software License, Version 1.0. (See accompanying
86        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>)
87      </p>
88</div></td>
89</tr></table>
90<hr>
91<div class="spirit-nav">
92<a accesskey="p" href="buffer/overload32.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="buffer_cast/overload1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
93</div>
94</body>
95</html>
96