1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>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="../rt_param_reference.html" title="Runtime parameters reference"> 9<link rel="prev" href="detect_fp_exceptions.html" title="detect_fp_exceptions"> 10<link rel="next" href="help.html" title="help"> 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_fp_exceptions.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rt_param_reference.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="help.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="boost_test.utf_reference.rt_param_reference.detect_memory_leaks"></a><a class="link" href="detect_memory_leaks.html" title="detect_memory_leaks"><code class="computeroutput"><span class="identifier">detect_memory_leaks</span></code></a> 28</h4></div></div></div> 29<p> 30 Parameter <span class="emphasis"><em>detect_memory_leaks</em></span> enables/disables memory 31 leaks detection (if present in your build configuration). This parameter 32 has an optional long integer value. The default value is 1, which enables 33 memory leak detection. The value 0 disables memory leak detection. Any 34 value N greater than 1 is treated as leak allocation number and tells the 35 framework to setup runtime breakpoint at Nth heap allocation. If value 36 is omitted the default value is assumed. 37 </p> 38<div class="note"><table border="0" summary="Note"> 39<tr> 40<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td> 41<th align="left">Note</th> 42</tr> 43<tr><td align="left" valign="top"><p> 44 The only platform which supports memory leak detection is Microsoft Visual 45 Studio family of compilers in debug builds. 46 </p></td></tr> 47</table></div> 48<h5> 49<a name="boost_test.utf_reference.rt_param_reference.detect_memory_leaks.h0"></a> 50 <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.detect_memory_leaks.acceptable_values"></a></span><a class="link" href="detect_memory_leaks.html#boost_test.utf_reference.rt_param_reference.detect_memory_leaks.acceptable_values">Acceptable 51 values</a> 52 </h5> 53<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 54<li class="listitem"> 55 0 56 </li> 57<li class="listitem"> 58 <span class="bold"><strong>1</strong></span> (default) 59 </li> 60<li class="listitem"> 61 <a class="link" href="../rt_param_reference.html#regular_param_value">long integer value</a> > 62 1 63 </li> 64</ul></div> 65<h5> 66<a name="boost_test.utf_reference.rt_param_reference.detect_memory_leaks.h1"></a> 67 <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.detect_memory_leaks.command_line_syntax"></a></span><a class="link" href="detect_memory_leaks.html#boost_test.utf_reference.rt_param_reference.detect_memory_leaks.command_line_syntax">Command 68 line syntax</a> 69 </h5> 70<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 71 <code class="computeroutput"><span class="special">--</span><span class="identifier">detect_memory_leaks</span><span class="special">[=<</span><span class="identifier">alloc</span> 72 <span class="identifier">order</span> <span class="identifier">number</span><span class="special">>]</span></code> 73 </li></ul></div> 74<h5> 75<a name="boost_test.utf_reference.rt_param_reference.detect_memory_leaks.h2"></a> 76 <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.detect_memory_leaks.environment_variable"></a></span><a class="link" href="detect_memory_leaks.html#boost_test.utf_reference.rt_param_reference.detect_memory_leaks.environment_variable">Environment 77 variable</a> 78 </h5> 79<pre class="programlisting"><span class="identifier">BOOST_TEST_DETECT_MEMORY_LEAK</span> 80</pre> 81</div> 82<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 83<td align="left"></td> 84<td align="right"><div class="copyright-footer">Copyright © 2001-2020 Boost.Test contributors<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="detect_fp_exceptions.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rt_param_reference.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="help.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 93</div> 94</body> 95</html> 96
