libs/test/doc/html/boost/debug/detect_memory_leaks.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function detect_memory_leaks</title>
   5 <link rel="stylesheet" href="../../boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Boost.Test">
   8 <link rel="up" href="../../header/boost/test/debug_hpp.html" title="Header &lt;boost/test/debug.hpp&gt;">
   9 <link rel="prev" href="attach_debugger.html" title="Function attach_debugger">
  10 <link rel="next" href="break_memory_alloc.html" title="Function break_memory_alloc">
  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="attach_debugger.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/test/debug_hpp.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="break_memory_alloc.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.debug.detect_memory_leaks"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function detect_memory_leaks</span></h2>
  29 <p>boost::debug::detect_memory_leaks &#8212; Switches on/off memory leaks detection. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../header/boost/test/debug_hpp.html" title="Header &lt;boost/test/debug.hpp&gt;">boost/test/debug.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">void</span> <span class="identifier">detect_memory_leaks</span><span class="special">(</span><span class="keyword">bool</span> on_off<span class="special">,</span>
  36                          <span class="identifier">unit_test</span><span class="special">::</span><span class="identifier">const_string</span> report_file <span class="special">=</span> <span class="identifier">unit_test</span><span class="special">::</span><span class="identifier">const_string</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div>
  37 <div class="refsect1">
  38 <a name="idm45313890862976"></a><h2>Description</h2>
  39 <p>On platforms where memory leak detection is possible inside of running application (at the moment this is only Windows family) you can switch this feature on and off using this interface. In addition you can specify the name of the file to write a report into. Otherwise the report is going to be generated in standard error stream.
  40 </p>
  41 <div class="variablelist"><table border="0" class="variablelist compact">
  42 <colgroup>
  43 <col align="left" valign="top">
  44 <col>
  45 </colgroup>
  46 <tbody><tr>
  47 <td><p><span class="term">Parameters:</span></p></td>
  48 <td><div class="variablelist"><table border="0" class="variablelist compact">
  49 <colgroup>
  50 <col align="left" valign="top">
  51 <col>
  52 </colgroup>
  53 <tbody>
  54 <tr>
  55 <td><p><span class="term"><code class="computeroutput">on_off</code></span></p></td>
  56 <td><p>boolean switch </p></td>
  57 </tr>
  58 <tr>
  59 <td><p><span class="term"><code class="computeroutput">report_file</code></span></p></td>
  60 <td><p>file, where the report should be directed to </p></td>
  61 </tr>
  62 </tbody>
  63 </table></div></td>
  64 </tr></tbody>
  65 </table></div>
  66 </div>
  67 </div>
  68 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  69 <td align="left"></td>
  70 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  71       contributors<p>
  72         Distributed under the Boost Software License, Version 1.0. (See accompanying
  73         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>)
  74       </p>
  75 </div></td>
  76 </tr></table>
  77 <hr>
  78 <div class="spirit-nav">
  79 <a accesskey="p" href="attach_debugger.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/test/debug_hpp.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="break_memory_alloc.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  80 </div>
  81 </body>
  82 </html>