libs/test/doc/html/boost_test/utf_reference/rt_param_reference/result_code.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>result_code</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="report_sink.html" title="report_sink">
  10 <link rel="next" href="run_test.html" title="run_test">
  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="report_sink.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="run_test.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.result_code"></a><a class="link" href="result_code.html" title="result_code"><code class="computeroutput"><span class="identifier">result_code</span></code></a>
  28 </h4></div></div></div>
  29 <p>
  30           The "no" argument value for the option [`result_code] instructs
  31           the <span class="emphasis"><em>Unit Test Framework</em></span> to always return zero result
  32           code. This could be used for test programs executed within IDE. By default
  33           this parameter has value "yes". See the <a class="link" href="../../practical_usage_recommendations.html#ref_usage_recommendations">usage
  34           recommendations</a> section for more details.
  35         </p>
  36 <h5>
  37 <a name="boost_test.utf_reference.rt_param_reference.result_code.h0"></a>
  38           <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.result_code.acceptable_values"></a></span><a class="link" href="result_code.html#boost_test.utf_reference.rt_param_reference.result_code.acceptable_values">Acceptable
  39           values</a>
  40         </h5>
  41 <p>
  42           <a class="link" href="../rt_param_reference.html#boolean_param_value">Boolean</a> with default value
  43           <span class="bold"><strong>yes</strong></span>.
  44         </p>
  45 <h5>
  46 <a name="boost_test.utf_reference.rt_param_reference.result_code.h1"></a>
  47           <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.result_code.command_line_syntax"></a></span><a class="link" href="result_code.html#boost_test.utf_reference.rt_param_reference.result_code.command_line_syntax">Command
  48           line syntax</a>
  49         </h5>
  50 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  51 <li class="listitem">
  52               <code class="computeroutput"><span class="special">--</span><span class="identifier">result_code</span><span class="special">[=&lt;</span><span class="identifier">boolean</span>
  53               <span class="identifier">value</span><span class="special">&gt;]</span></code>
  54             </li>
  55 <li class="listitem">
  56               <code class="computeroutput"><span class="special">-</span><span class="identifier">c</span>
  57               <span class="special">[&lt;</span><span class="identifier">boolean</span>
  58               <span class="identifier">value</span><span class="special">&gt;]</span></code>
  59             </li>
  60 </ul></div>
  61 <h5>
  62 <a name="boost_test.utf_reference.rt_param_reference.result_code.h2"></a>
  63           <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.result_code.environment_variable"></a></span><a class="link" href="result_code.html#boost_test.utf_reference.rt_param_reference.result_code.environment_variable">Environment
  64           variable</a>
  65         </h5>
  66 <pre class="programlisting"><span class="identifier">BOOST_TEST_RESULT_CODE</span>
  67 </pre>
  68 </div>
  69 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  70 <td align="left"></td>
  71 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  72       contributors<p>
  73         Distributed under the Boost Software License, Version 1.0. (See accompanying
  74         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>)
  75       </p>
  76 </div></td>
  77 </tr></table>
  78 <hr>
  79 <div class="spirit-nav">
  80 <a accesskey="p" href="report_sink.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="run_test.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  81 </div>
  82 </body>
  83 </html>