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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function run</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="get_idm45665013547648.html" title="Function template get">
  10 <link rel="next" href="../init_unit_test_func.html" title="Type definition init_unit_test_func">
  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="get_idm45665013547648.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="../init_unit_test_func.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.unit_test.framework.run_idm45665013542144"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function run</span></h2>
  29 <p>boost::unit_test::framework::run &#8212; Initiates test execution. </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">run</span><span class="special">(</span><span class="identifier">test_unit_id</span> tu <span class="special">=</span> <span class="identifier">INV_TEST_UNIT_ID</span><span class="special">,</span> <span class="keyword">bool</span> continue_test <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre></div>
  36 <div class="refsect1">
  37 <a name="idm45734499796352"></a><h2>Description</h2>
  38 <p>This function is used to start the test execution from a specific "root" test unit. If no root provided, test is started from master test suite. This second argument facilitates an ability of the test cases to start some other test units (primarily used internally for self testing).
  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>
  53 <tr>
  54 <td><p><span class="term"><code class="computeroutput">continue_test</code></span></p></td>
  55 <td><p>true == continue test if it was already started, false == restart the test from scratch regardless </p></td>
  56 </tr>
  57 <tr>
  58 <td><p><span class="term"><code class="computeroutput">tu</code></span></p></td>
  59 <td><p>Optional id of the test unit or test unit itself from which the test is started. If absent, master test suite is used </p></td>
  60 </tr>
  61 </tbody>
  62 </table></div></td>
  63 </tr></tbody>
  64 </table></div>
  65 </div>
  66 </div>
  67 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  68 <td align="left"></td>
  69 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2018 Boost.Test contributors<p>
  70         Distributed under the Boost Software License, Version 1.0. (See accompanying
  71         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>)
  72       </p>
  73 </div></td>
  74 </tr></table>
  75 <hr>
  76 <div class="spirit-nav">
  77 <a accesskey="p" href="get_idm45665013547648.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="../init_unit_test_func.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  78 </div>
  79 </body>
  80 </html>