libs/test/doc/html/boost/unit_test/framework/deregister_test_unit.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function deregister_test_unit</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/framework_hpp.html" title="Header &lt;boost/test/framework.hpp&gt;">
   9 <link rel="prev" href="register_idm46279113744304.html" title="Function register_test_unit">
  10 <link rel="next" href="register_observer.html" title="Function register_observer">
  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="register_idm46279113744304.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/framework_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="register_observer.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.unit_test.framework.deregister_test_unit"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function deregister_test_unit</span></h2>
  29 <p>boost::unit_test::framework::deregister_test_unit &#8212; This function removes the test unit from the collection of known test units and destroys the test unit object. </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/framework_hpp.html" title="Header &lt;boost/test/framework.hpp&gt;">boost/test/framework.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">void</span> <span class="identifier">deregister_test_unit</span><span class="special">(</span><a class="link" href="../test_unit.html" title="Class test_unit">test_unit</a> <span class="special">*</span> tu<span class="special">)</span><span class="special">;</span></pre></div>
  36 <div class="refsect1">
  37 <a name="idm45313889699776"></a><h2>Description</h2>
  38 <p>This function also assigns unique test unit id for every test case. Later on one can use this id to located the test case if necessary. This is the way for the framework to maintain weak references between test units.
  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">tu</code></span></p></td>
  54 <td><p>test unit to deregister </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-2019 Boost.Test
  64       contributors<p>
  65         Distributed under the Boost Software License, Version 1.0. (See accompanying
  66         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>)
  67       </p>
  68 </div></td>
  69 </tr></table>
  70 <hr>
  71 <div class="spirit-nav">
  72 <a accesskey="p" href="register_idm46279113744304.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/framework_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="register_observer.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  73 </div>
  74 </body>
  75 </html>