summaryrefslogtreecommitdiff
path: root/doc/html/id1287075.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/id1287075.html')
-rw-r--r--doc/html/id1287075.html55
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/html/id1287075.html b/doc/html/id1287075.html
new file mode 100644
index 0000000000..c71e10c6f2
--- /dev/null
+++ b/doc/html/id1287075.html
@@ -0,0 +1,55 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Function template operator&gt;&gt;</title>
+<link rel="stylesheet" href="boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
+<link rel="start" href="index.html" title="The Boost C++ Libraries">
+<link rel="up" href="tribool/reference.html#id1277344" title="Header &lt;boost/logic/tribool_io.hpp&gt;">
+<link rel="prev" href="id1286986.html" title="Function template operator&lt;&lt;">
+<link rel="next" href="tribool/tests.html" title="Testsuite">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
+<td align="center"><a href="../../index.htm">Home</a></td>
+<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
+<td align="center"><a href="../../people/people.htm">People</a></td>
+<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
+<td align="center"><a href="../../more/index.htm">More</a></td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="id1286986.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="tribool/reference.html#id1277344"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="tribool/tests.html"><img src="images/next.png" alt="Next"></a>
+</div>
+<div class="refentry" lang="en">
+<a name="id1287075"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2><span class="refentrytitle">Function template operator&gt;&gt;</span></h2>
+<p>boost::logic::operator&gt;&gt; &#8212; Reads a tribool value from a stream. </p>
+</div>
+<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
+<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">
+<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits&gt;
+  <span class="type">std::basic_istream&lt; CharT, Traits &gt; &amp;</span>
+  <span class="bold"><strong>operator</strong></span>&gt;&gt;(std::basic_istream&lt; CharT, Traits &gt; &amp; in, <a href="boost/logic/tribool.html" title="Class tribool">tribool</a> &amp; x);</pre></div>
+<div class="refsect1" lang="en">
+<a name="id1572159"></a><h2>Description</h2>
+<p>When <code class="computeroutput">(out.flags() &amp; std::ios_base::boolalpha) == 0</code> , this function reads a <code class="computeroutput">long</code> value from the input stream <code class="computeroutput">in</code> and converts that value to a tribool. If that value is 0, <code class="computeroutput">x</code> becomes <code class="computeroutput">false</code> ; if it is 1, <code class="computeroutput">x</code> becomes <code class="computeroutput">true</code> ; if it is 2, <code class="computeroutput">becomes</code><code class="computeroutput">indetermine</code> ; otherwise, the operation fails (and the fail bit is set on the input stream <code class="computeroutput">in</code> ).</p>
+<p>When <code class="computeroutput">(out.flags() &amp; std::ios_base::boolalpha) != 0</code> , this function first determines the names of the false, true, and indeterminate values. The false and true names are extracted from the <code class="computeroutput">std::numpunct</code> facet of the input stream's locale (if the C++ standard library implementation supports locales), or from the <code class="computeroutput">default_false_name</code> and <code class="computeroutput">default_true_name</code> functions (if there is no locale support). The indeterminate name is extracted from the appropriate <code class="computeroutput">indeterminate_name</code> facet (if it is available in the input stream's locale), or from the <code class="computeroutput">get_default_indeterminate_name</code> function (if the C++ standard library implementation does not support locales, or the <code class="computeroutput">indeterminate_name</code> facet is not specified for this locale object). The input is then matched to each of these names, and the tribool <code class="computeroutput">x</code> is assigned the value corresponding to the longest name that matched. If no name is matched or all names are empty, the operation fails (and the fail bit is set on the input stream <code class="computeroutput">in</code> ).</p>
+<p></p>
+<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Returns</span></b>:
+
+ <code class="computeroutput">in</code></p>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2002-2004 Douglas Gregor</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="id1286986.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="tribool/reference.html#id1277344"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="tribool/tests.html"><img src="images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>