doc/html/boost/program_options/bool_switch.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Function bool_switch</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header &lt;boost/program_options/value_semantic.hpp&gt;">
  10 <link rel="prev" href="wvalue.html" title="Function wvalue">
  11 <link rel="next" href="variable_value.html" title="Class variable_value">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="wvalue.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp"><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="variable_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.program_options.bool_switch"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Function bool_switch</span></h2>
  30 <p>boost::program_options::bool_switch</p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <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="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header &lt;boost/program_options/value_semantic.hpp&gt;">boost/program_options/value_semantic.hpp</a>&gt;
  34
  35 </span>
  36 <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a><span class="special">&lt;</span> <span class="keyword">bool</span> <span class="special">&gt;</span> <span class="special">*</span> <span class="identifier">bool_switch</span><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  37 <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a><span class="special">&lt;</span> <span class="keyword">bool</span> <span class="special">&gt;</span> <span class="special">*</span> <span class="identifier">bool_switch</span><span class="special">(</span><span class="keyword">bool</span> <span class="special">*</span> v<span class="special">)</span><span class="special">;</span></pre></div>
  38 <div class="refsect1">
  39 <a name="idp440092240"></a><h2>Description</h2>
  40 <p>Works the same way as the 'value&lt;bool&gt;' function, but the created <code class="computeroutput"><a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a></code> won't accept any explicit value. So, if the option is present on the command line, the value will be 'true'. </p>
  41 </div>
  42 </div>
  43 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  44 <td align="left"></td>
  45 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0.
  46       (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at
  47       <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  48       </p>
  49 </div></td>
  50 </tr></table>
  51 <hr>
  52 <div class="spirit-nav">
  53 <a accesskey="p" href="wvalue.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp"><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="variable_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  54 </div>
  55 </body>
  56 </html>