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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function break_memory_alloc</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="detect_memory_leaks.html" title="Function detect_memory_leaks">
  10 <link rel="next" href="../../header/boost/test/debug_config_hpp.html" title="Header &lt;boost/test/debug_config.hpp&gt;">
  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="detect_memory_leaks.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="../../header/boost/test/debug_config_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.debug.break_memory_alloc"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function break_memory_alloc</span></h2>
  29 <p>boost::debug::break_memory_alloc &#8212; Causes program to break execution in debugger at specific allocation point. </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">break_memory_alloc</span><span class="special">(</span><span class="keyword">long</span> mem_alloc_order_num<span class="special">)</span><span class="special">;</span></pre></div>
  36 <div class="refsect1">
  37 <a name="idp127033504"></a><h2>Description</h2>
  38 <p>On some platforms/memory managers (at the moment only on Windows/Visual Studio) one can tell a C Runtime to break on specific memory allocation. This can be used in combination with memory leak detection (which reports leaked memory allocation number) to locate the place where leak initiated.
  39 </p>
  40 <div class="variablelist"><table border="0" class="variablelist compact">
  41 <colgroup>
  42 <col align="left" valign="top">
  43 <col>
  44 </colgroup>
  45 <tbody><tr>
  46 <td><p><span class="term">Parameters:</span></p></td>
  47 <td><div class="variablelist"><table border="0" class="variablelist compact">
  48 <colgroup>
  49 <col align="left" valign="top">
  50 <col>
  51 </colgroup>
  52 <tbody><tr>
  53 <td><p><span class="term"><code class="computeroutput">mem_alloc_order_num</code></span></p></td>
  54 <td><p>Specific memory allocation number </p></td>
  55 </tr></tbody>
  56 </table></div></td>
  57 </tr></tbody>
  58 </table></div>
  59 </div>
  60 </div>
  61 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  62 <td align="left"></td>
  63 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2016 Boost.Test contributors<p>
  64         Distributed under the Boost Software License, Version 1.0. (See accompanying
  65         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>)
  66       </p>
  67 </div></td>
  68 </tr></table>
  69 <hr>
  70 <div class="spirit-nav">
  71 <a accesskey="p" href="detect_memory_leaks.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="../../header/boost/test/debug_config_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  72 </div>
  73 </body>
  74 </html>