2
0
mirror of https://github.com/boostorg/test.git synced 2026-01-27 07:22:11 +00:00
Files
test/doc/components/test_tools/reference/BOOST_CHECK.html
Gennadiy Rozental 21cc4d85ce major update to the docs
[SVN r21952]
2004-01-26 10:13:35 +00:00

43 lines
1.9 KiB
HTML

<HTML>
<HEAD>
<TITLE>The Test Tools</TITLE>
<LINK rel="stylesheet" type="text/css" href="../../../style/btl.css" media="screen">
<LINK rel="stylesheet" type="text/css" href="../../../style/btl-print.css" media="print">
<META http-equiv="Content-Language" content="en-us">
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<STYLE type="text/css">
H4
{
margin: 0px;
}
</STYLE>
</HEAD>
<BODY>
<DIV class="body">
<H3>BOOST_CHECK( predicate )</H3>
<P class="first-line-indented">This tool is used to validate the predicate value. </P>
<P class="first-line-indented">If predicate value is true, the tool produces a confirmation message
(note: to manage what messages appear in the test output stream set the proper log level) in other
case it produces an error message in a form &quot;error in &lt;test case name&gt;: test &lt;predicate&gt;
failed&quot;. </P>
<P class="first-line-indented">The only parameter of this tool is the boolean predicate value that gets
validated. This could be any expression that could be evaluated and converted to boolean value. The
expression gets evaluated only once, so it's safe to pass complex expression for validation.</P>
<H4>Example: test.cpp</H4>
<PRE class="code"><SPAN class="cpp-type">int</SPAN> test_main( <SPAN class="cpp-type">int</SPAN>, <SPAN class="cpp-type">char</SPAN>* [] ) {
<SPAN class="cpp-type">int</SPAN> i=<SPAN class="literal">2</SPAN>;
BOOST_CHECK( i == <SPAN class="literal">1</SPAN> );
<SPAN class="reserv-word">return</SPAN> <SPAN class="literal">0</SPAN>;
}</PRE>
<H4>Output:</H4>
<P class="test-output">test.cpp(3) : error in test_main: test i==1 failed
</P>
<DIV class="see_also">
<H4>See Also</H4>
<P class="see-also-content"><A href="BOOST_CHECK_MESSAGE.html" target="descr">BOOST_CHECK_MESSAGE</A></P>
</DIV>
</DIV>
</BODY>
</HTML>