1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>windows::overlapped_ptr</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="windows__overlapped_handle.html" title="windows::overlapped_handle"> 10<link rel="next" href="windows__overlapped_ptr/complete.html" title="windows::overlapped_ptr::complete"> 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="windows__overlapped_handle.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="windows__overlapped_ptr/complete.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.windows__overlapped_ptr"></a><a class="link" href="windows__overlapped_ptr.html" title="windows::overlapped_ptr">windows::overlapped_ptr</a> 28</h3></div></div></div> 29<p> 30 Wraps a handler to create an OVERLAPPED object for use with overlapped I/O. 31 </p> 32<pre class="programlisting">class overlapped_ptr : 33 noncopyable 34</pre> 35<h5> 36<a name="boost_asio.reference.windows__overlapped_ptr.h0"></a> 37 <span class="phrase"><a name="boost_asio.reference.windows__overlapped_ptr.member_functions"></a></span><a class="link" href="windows__overlapped_ptr.html#boost_asio.reference.windows__overlapped_ptr.member_functions">Member 38 Functions</a> 39 </h5> 40<div class="informaltable"><table class="table"> 41<colgroup> 42<col> 43<col> 44</colgroup> 45<thead><tr> 46<th> 47 <p> 48 Name 49 </p> 50 </th> 51<th> 52 <p> 53 Description 54 </p> 55 </th> 56</tr></thead> 57<tbody> 58<tr> 59<td> 60 <p> 61 <a class="link" href="windows__overlapped_ptr/complete.html" title="windows::overlapped_ptr::complete"><span class="bold"><strong>complete</strong></span></a> 62 </p> 63 </td> 64<td> 65 <p> 66 Post completion notification for overlapped operation. Releases 67 ownership. 68 </p> 69 </td> 70</tr> 71<tr> 72<td> 73 <p> 74 <a class="link" href="windows__overlapped_ptr/get.html" title="windows::overlapped_ptr::get"><span class="bold"><strong>get</strong></span></a> 75 </p> 76 </td> 77<td> 78 <p> 79 Get the contained OVERLAPPED object. 80 </p> 81 </td> 82</tr> 83<tr> 84<td> 85 <p> 86 <a class="link" href="windows__overlapped_ptr/overlapped_ptr.html" title="windows::overlapped_ptr::overlapped_ptr"><span class="bold"><strong>overlapped_ptr</strong></span></a> <span class="silver">[constructor]</span> 87 </p> 88 </td> 89<td> 90 <p> 91 Construct an empty overlapped_ptr. <br> <span class="silver"> —</span><br> Construct an overlapped_ptr 92 to contain the specified handler. 93 </p> 94 </td> 95</tr> 96<tr> 97<td> 98 <p> 99 <a class="link" href="windows__overlapped_ptr/release.html" title="windows::overlapped_ptr::release"><span class="bold"><strong>release</strong></span></a> 100 </p> 101 </td> 102<td> 103 <p> 104 Release ownership of the OVERLAPPED object. 105 </p> 106 </td> 107</tr> 108<tr> 109<td> 110 <p> 111 <a class="link" href="windows__overlapped_ptr/reset.html" title="windows::overlapped_ptr::reset"><span class="bold"><strong>reset</strong></span></a> 112 </p> 113 </td> 114<td> 115 <p> 116 Reset to empty. <br> <span class="silver"> —</span><br> Reset to contain the specified handler, 117 freeing any current OVERLAPPED object. 118 </p> 119 </td> 120</tr> 121<tr> 122<td> 123 <p> 124 <a class="link" href="windows__overlapped_ptr/_overlapped_ptr.html" title="windows::overlapped_ptr::~overlapped_ptr"><span class="bold"><strong>~overlapped_ptr</strong></span></a> <span class="silver">[destructor]</span> 125 </p> 126 </td> 127<td> 128 <p> 129 Destructor automatically frees the OVERLAPPED object unless released. 130 </p> 131 </td> 132</tr> 133</tbody> 134</table></div> 135<p> 136 A special-purpose smart pointer used to wrap an application handler so that 137 it can be passed as the LPOVERLAPPED argument to overlapped I/O functions. 138 </p> 139<h5> 140<a name="boost_asio.reference.windows__overlapped_ptr.h1"></a> 141 <span class="phrase"><a name="boost_asio.reference.windows__overlapped_ptr.thread_safety"></a></span><a class="link" href="windows__overlapped_ptr.html#boost_asio.reference.windows__overlapped_ptr.thread_safety">Thread 142 Safety</a> 143 </h5> 144<p> 145 <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe. 146 </p> 147<p> 148 <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. 149 </p> 150<h5> 151<a name="boost_asio.reference.windows__overlapped_ptr.h2"></a> 152 <span class="phrase"><a name="boost_asio.reference.windows__overlapped_ptr.requirements"></a></span><a class="link" href="windows__overlapped_ptr.html#boost_asio.reference.windows__overlapped_ptr.requirements">Requirements</a> 153 </h5> 154<p> 155 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/windows/overlapped_ptr.hpp</code> 156 </p> 157<p> 158 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 159 </p> 160</div> 161<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 162<td align="left"></td> 163<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 164 Kohlhoff<p> 165 Distributed under the Boost Software License, Version 1.0. (See accompanying 166 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>) 167 </p> 168</div></td> 169</tr></table> 170<hr> 171<div class="spirit-nav"> 172<a accesskey="p" href="windows__overlapped_handle.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="windows__overlapped_ptr/complete.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 173</div> 174</body> 175</html> 176
