File: validation_error.html

package info (click to toggle)
boost1.42 1.42.0-4
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 277,864 kB
  • ctags: 401,076
  • sloc: cpp: 1,235,659; xml: 74,142; ansic: 41,313; python: 26,756; sh: 11,840; cs: 2,118; makefile: 655; perl: 494; yacc: 456; asm: 353; csh: 6
file content (99 lines) | stat: -rwxr-xr-x 8,399 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class validation_error</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header &lt;boost/program_options/errors.hpp&gt;">
<link rel="prev" href="multiple_occurrences.html" title="Class multiple_occurrences">
<link rel="next" href="invalid_option_value.html" title="Class invalid_option_value">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="multiple_occurrences.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="invalid_option_value.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Class validation_error">
<a name="boost.program_options.validation_error"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class validation_error</span></h2>
<p>boost::program_options::validation_error</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="emphasis"><em>// 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;

</em></span>
<span class="bold"><strong>class</strong></span> <a class="link" href="validation_error.html" title="Class validation_error">validation_error</a> : <span class="bold"><strong>public</strong></span> boost::program_options::error {
<span class="bold"><strong>public</strong></span>:

  <span class="bold"><strong>enum</strong></span> <a name="boost.program_options.validation_error.kind_t"></a>kind_t { multiple_values_not_allowed =  30, 
                at_least_one_value_required, invalid_bool_value, 
                invalid_option_value, invalid_option };
  <span class="emphasis"><em>// <a class="link" href="validation_error.html#boost.program_options.validation_errorconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a class="link" href="validation_error.html#id902498-bb">validation_error</a>(kind_t, <span class="bold"><strong>const</strong></span> std::string &amp; = "", <span class="bold"><strong>const</strong></span> std::string &amp; = "");
  <a class="link" href="validation_error.html#id902519-bb">~validation_error</a>();

  <span class="emphasis"><em>// <a class="link" href="validation_error.html#id902470-bb">public member functions</a></em></span>
  <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="validation_error.html#id902473-bb">set_option_name</a>(<span class="bold"><strong>const</strong></span> std::string &amp;) ;
  <span class="type"><span class="bold"><strong>const</strong></span> std::string &amp;</span> <a class="link" href="validation_error.html#id902485-bb">get_option_name</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a class="link" href="validation_error.html#id902492-bb">what</a>() <span class="bold"><strong>const</strong></span>;

  <span class="emphasis"><em>// <a class="link" href="validation_error.html#id902520-bb">protected static functions</a></em></span>
  <span class="type"><span class="bold"><strong>static</strong></span> std::string</span> <a class="link" href="validation_error.html#id902523-bb">error_message</a>(kind_t) ;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id1425058"></a><h2>Description</h2>
<p>Class thrown when value of option is incorrect. </p>
<div class="refsect2" title="validation_error public construct/copy/destruct">
<a name="id1425065"></a><h3>
<a name="boost.program_options.validation_errorconstruct-copy-destruct"></a><code class="computeroutput">validation_error</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><a name="id902498-bb"></a>validation_error(kind_t kind, <span class="bold"><strong>const</strong></span> std::string &amp; option_value = "", 
                 <span class="bold"><strong>const</strong></span> std::string &amp; option_name = "");</pre></li>
<li class="listitem"><pre class="literallayout"><a name="id902519-bb"></a>~validation_error();</pre></li>
</ol></div>
</div>
<div class="refsect2" title="validation_error public member functions">
<a name="id1425127"></a><h3>
<a name="id902470-bb"></a><code class="computeroutput">validation_error</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id902473-bb"></a>set_option_name(<span class="bold"><strong>const</strong></span> std::string &amp; option) ;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> std::string &amp;</span> <a name="id902485-bb"></a>get_option_name() <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a name="id902492-bb"></a>what() <span class="bold"><strong>const</strong></span>;</pre></li>
</ol></div>
</div>
<div class="refsect2" title="validation_error protected static functions">
<a name="id1425229"></a><h3>
<a name="id902520-bb"></a><code class="computeroutput">validation_error</code> protected static functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> std::string</span> <a name="id902523-bb"></a>error_message(kind_t kind) ;</pre>
<p>Used to convert kind_t to a related error text </p>
</li></ol></div>
</div>
</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"><div class="copyright-footer">Copyright &#169; 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0.
      (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at 
      <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="multiple_occurrences.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="invalid_option_value.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>