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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>list_labels</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="list_content.html" title="list_content">
  10 <link rel="next" href="log_format.html" title="log_format">
  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="list_content.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="log_format.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.list_labels"></a><a class="link" href="list_labels.html" title="list_labels"><code class="computeroutput"><span class="identifier">list_labels</span></code></a>
  28 </h4></div></div></div>
  29 <p>
  30           Lists the labels associated to the <a class="link" href="../../section_glossary.html#ref_test_unit">test units</a>
  31           in the current <a class="link" href="../../section_glossary.html#ref_test_module">test module</a> and exits
  32           (no test is run).
  33         </p>
  34 <div class="tip"><table border="0" summary="Tip">
  35 <tr>
  36 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../../doc/src/images/tip.png"></td>
  37 <th align="left">Tip</th>
  38 </tr>
  39 <tr><td align="left" valign="top"><p>
  40             See <a class="link" href="../../tests_organization/tests_grouping.html" title="Grouping tests into logical units by labels">this
  41             section</a> for more details on labels and logical grouping of test
  42             cases.
  43           </p></td></tr>
  44 </table></div>
  45 <h5>
  46 <a name="boost_test.utf_reference.rt_param_reference.list_labels.h0"></a>
  47           <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.list_labels.acceptable_values"></a></span><a class="link" href="list_labels.html#boost_test.utf_reference.rt_param_reference.list_labels.acceptable_values">Acceptable
  48           values</a>
  49         </h5>
  50 <p>
  51           <a class="link" href="../rt_param_reference.html#boolean_param_value">Boolean</a> with default value
  52           <span class="bold"><strong>no</strong></span>.
  53         </p>
  54 <h5>
  55 <a name="boost_test.utf_reference.rt_param_reference.list_labels.h1"></a>
  56           <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.list_labels.command_line_syntax"></a></span><a class="link" href="list_labels.html#boost_test.utf_reference.rt_param_reference.list_labels.command_line_syntax">Command
  57           line syntax</a>
  58         </h5>
  59 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  60               <code class="computeroutput"><span class="special">--</span><span class="identifier">list_labels</span><span class="special">[=&lt;</span><span class="identifier">boolean</span>
  61               <span class="identifier">value</span><span class="special">&gt;]</span></code>
  62             </li></ul></div>
  63 <h5>
  64 <a name="boost_test.utf_reference.rt_param_reference.list_labels.h2"></a>
  65           <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.list_labels.environment_variable"></a></span><a class="link" href="list_labels.html#boost_test.utf_reference.rt_param_reference.list_labels.environment_variable">Environment
  66           variable</a>
  67         </h5>
  68 <pre class="programlisting"><span class="identifier">BOOST_TEST_LIST_LABELS</span>
  69 </pre>
  70 <h5>
  71 <a name="boost_test.utf_reference.rt_param_reference.list_labels.h3"></a>
  72           <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.list_labels.example"></a></span><a class="link" href="list_labels.html#boost_test.utf_reference.rt_param_reference.list_labels.example">Example</a>
  73         </h5>
  74 <p>
  75           The previous example from <a class="link" href="list_content.html" title="list_content"><code class="computeroutput"><span class="special">--</span><span class="identifier">list_content</span></code></a>
  76           gives
  77         </p>
  78 <pre class="programlisting"><span class="special">&gt;</span> <span class="special">./</span><span class="identifier">boost_runtime_list_content</span> <span class="special">--</span><span class="identifier">list_labels</span>
  79 <span class="identifier">Available</span> <span class="identifier">labels</span><span class="special">:</span>
  80   <span class="identifier">label1</span>
  81   <span class="identifier">label2</span>
  82 </pre>
  83 </div>
  84 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  85 <td align="left"></td>
  86 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  87       contributors<p>
  88         Distributed under the Boost Software License, Version 1.0. (See accompanying
  89         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>)
  90       </p>
  91 </div></td>
  92 </tr></table>
  93 <hr>
  94 <div class="spirit-nav">
  95 <a accesskey="p" href="list_content.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="log_format.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  96 </div>
  97 </body>
  98 </html>