doc/html/boost/program_options/invalid_option_value.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class invalid_option_value</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header &lt;boost/program_options/errors.hpp&gt;">
   9 <link rel="prev" href="validation_error.html" title="Class validation_error">
  10 <link rel="next" href="invalid_bool_value.html" title="Class invalid_bool_value">
  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="validation_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_bool_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.program_options.invalid_option_value"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class invalid_option_value</span></h2>
  29 <p>boost::program_options::invalid_option_value</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="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header &lt;boost/program_options/errors.hpp&gt;">boost/program_options/errors.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="invalid_option_value.html" title="Class invalid_option_value">invalid_option_value</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">validation_error</span> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="invalid_option_value.html#boost.program_options.invalid_option_valueconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="invalid_option_value.html#idp228285232-bb"><span class="identifier">invalid_option_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  39   <a class="link" href="invalid_option_value.html#idp212595760-bb"><span class="identifier">invalid_option_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  40 <span class="special">}</span><span class="special">;</span></pre></div>
  41 <div class="refsect1">
  42 <a name="idp344799392"></a><h2>Description</h2>
  43 <p>Class thrown if there is an invalid option value given </p>
  44 <div class="refsect2">
  45 <a name="idp344800128"></a><h3>
  46 <a name="boost.program_options.invalid_option_valueconstruct-copy-destruct"></a><code class="computeroutput">invalid_option_value</code>
  47         public
  48        construct/copy/destruct</h3>
  49 <div class="orderedlist"><ol class="orderedlist" type="1">
  50 <li class="listitem"><pre class="literallayout"><a name="idp228285232-bb"></a><span class="identifier">invalid_option_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre></li>
  51 <li class="listitem"><pre class="literallayout"><a name="idp212595760-bb"></a><span class="identifier">invalid_option_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre></li>
  52 </ol></div>
  53 </div>
  54 </div>
  55 </div>
  56 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  57 <td align="left"></td>
  58 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0.
  59       (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at
  60       <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  61       </p>
  62 </div></td>
  63 </tr></table>
  64 <hr>
  65 <div class="spirit-nav">
  66 <a accesskey="p" href="validation_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_bool_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  67 </div>
  68 </body>
  69 </html>