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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template get</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_idp57212160.html" title="Function get">
  10 <link rel="next" href="run_idp57222256.html" title="Function run">
  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_idp57212160.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="run_idp57222256.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.unit_test.framework.get_idp57216752"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template get</span></h2>
  29 <p>boost::unit_test::framework::get &#8212; This function template provides access to a typed test unit by id. </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">template</span><span class="special">&lt;</span><span class="keyword">typename</span> UnitType<span class="special">&gt;</span> <span class="identifier">UnitType</span> <span class="special">&amp;</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">test_unit_id</span> id<span class="special">)</span><span class="special">;</span></pre></div>
  36 <div class="refsect1">
  37 <a name="idp128192240"></a><h2>Description</h2>
  38 <p>It will throw if you specify incorrect test unit type
  39
  40 </p>
  41 <div class="variablelist"><table border="0" class="variablelist compact">
  42 <colgroup>
  43 <col align="left" valign="top">
  44 <col>
  45 </colgroup>
  46 <tbody>
  47 <tr>
  48 <td><p><span class="term">Parameters:</span></p></td>
  49 <td><div class="variablelist"><table border="0" class="variablelist compact">
  50 <colgroup>
  51 <col align="left" valign="top">
  52 <col>
  53 </colgroup>
  54 <tbody><tr>
  55 <td><p><span class="term"><code class="computeroutput">id</code></span></p></td>
  56 <td><p>id of test unit to get </p></td>
  57 </tr></tbody>
  58 </table></div></td>
  59 </tr>
  60 <tr>
  61 <td><p><span class="term">Template Parameters:</span></p></td>
  62 <td><div class="variablelist"><table border="0" class="variablelist compact">
  63 <colgroup>
  64 <col align="left" valign="top">
  65 <col>
  66 </colgroup>
  67 <tbody><tr>
  68 <td><p><span class="term"><code class="computeroutput">UnitType</code></span></p></td>
  69 <td><p>compile time type of test unit to get (<code class="computeroutput"><a class="link" href="../test_suite.html" title="Class test_suite">test_suite</a></code> or <code class="computeroutput"><a class="link" href="../test_case.html" title="Class test_case">test_case</a></code>) </p></td>
  70 </tr></tbody>
  71 </table></div></td>
  72 </tr>
  73 </tbody>
  74 </table></div>
  75 </div>
  76 </div>
  77 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  78 <td align="left"></td>
  79 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2016 Boost.Test contributors<p>
  80         Distributed under the Boost Software License, Version 1.0. (See accompanying
  81         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>)
  82       </p>
  83 </div></td>
  84 </tr></table>
  85 <hr>
  86 <div class="spirit-nav">
  87 <a accesskey="p" href="get_idp57212160.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="run_idp57222256.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  88 </div>
  89 </body>
  90 </html>