• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Function add_context</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="deregister_global_fixture.html" title="Function deregister_global_fixture">
10<link rel="next" href="clear_context.html" title="Function clear_context">
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="deregister_global_fixture.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="clear_context.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="refentry">
26<a name="boost.unit_test.framework.add_context"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Function add_context</span></h2>
29<p>boost::unit_test::framework::add_context — Records context frame message. </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">int</span> <span class="identifier">add_context</span><span class="special">(</span><span class="identifier">lazy_ostream</span> <span class="keyword">const</span> <span class="special">&amp;</span> context_descr<span class="special">,</span> <span class="keyword">bool</span> sticky<span class="special">)</span><span class="special">;</span></pre></div>
36<div class="refsect1">
37<a name="idm46175619034288"></a><h2>Description</h2>
38<p>Some context frames are sticky - they can only explicitly cleared by specifying context id. Other (non sticky) context frames cleared after every assertion.
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>
55<tr>
56<td><p><span class="term"><code class="computeroutput">context_descr</code></span></p></td>
57<td><p>context frame message </p></td>
58</tr>
59<tr>
60<td><p><span class="term"><code class="computeroutput">sticky</code></span></p></td>
61<td><p>is this sticky frame or not </p></td>
62</tr>
63</tbody>
64</table></div></td>
65</tr>
66<tr>
67<td><p><span class="term">Returns:</span></p></td>
68<td><p>id of the newly created frame </p></td>
69</tr>
70</tbody>
71</table></div>
72</div>
73</div>
74<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
75<td align="left"></td>
76<td align="right"><div class="copyright-footer">Copyright © 2001-2020 Boost.Test contributors<p>
77        Distributed under the Boost Software License, Version 1.0. (See accompanying
78        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>)
79      </p>
80</div></td>
81</tr></table>
82<hr>
83<div class="spirit-nav">
84<a accesskey="p" href="deregister_global_fixture.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="clear_context.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
85</div>
86</body>
87</html>
88