1 | <html> |
---|
2 | <head> |
---|
3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
---|
4 | <title>Class validation_error</title> |
---|
5 | <link rel="stylesheet" href="boostbook.css" type="text/css"> |
---|
6 | <meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> |
---|
7 | <link rel="start" href="index.html" title="The Boost C++ Libraries"> |
---|
8 | <link rel="up" href="program_options/reference.html#id2399042" title="Header <boost/program_options/errors.hpp>"> |
---|
9 | <link rel="prev" href="multiple_occurrences.html" title="Class multiple_occurrences"> |
---|
10 | <link rel="next" href="invalid_option_value.html" title="Class invalid_option_value"> |
---|
11 | </head> |
---|
12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
---|
13 | <table cellpadding="2" width="100%"> |
---|
14 | <td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td> |
---|
15 | <td align="center"><a href="../../index.htm">Home</a></td> |
---|
16 | <td align="center"><a href="../../libs/libraries.htm">Libraries</a></td> |
---|
17 | <td align="center"><a href="../../people/people.htm">People</a></td> |
---|
18 | <td align="center"><a href="../../more/faq.htm">FAQ</a></td> |
---|
19 | <td align="center"><a href="../../more/index.htm">More</a></td> |
---|
20 | </table> |
---|
21 | <hr> |
---|
22 | <div class="spirit-nav"> |
---|
23 | <a accesskey="p" href="multiple_occurrences.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id2399042"><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="invalid_option_value.html"><img src="images/next.png" alt="Next"></a> |
---|
24 | </div> |
---|
25 | <div class="refentry" lang="en"> |
---|
26 | <a name="validation_error"></a><div class="titlepage"></div> |
---|
27 | <div class="refnamediv"> |
---|
28 | <h2><span class="refentrytitle">Class validation_error</span></h2> |
---|
29 | <p>boost::program_options::validation_error — </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"> |
---|
33 | <span class="bold"><strong>class</strong></span> validation_error : <span class="bold"><strong>public</strong></span> boost::program_options::error { |
---|
34 | <span class="bold"><strong>public</strong></span>: |
---|
35 | <span class="emphasis"><em>// <a href="validation_error.html#validation_errorconstruct-copy-destruct">construct/copy/destruct</a></em></span> |
---|
36 | <a href="validation_error.html#id2524851-bb">validation_error</a>(<span class="bold"><strong>const</strong></span> std::string &); |
---|
37 | <a href="validation_error.html#id2524865-bb">~validation_error</a>(); |
---|
38 | |
---|
39 | <span class="emphasis"><em>// <a href="validation_error.html#id2340618-bb">public member functions</a></em></span> |
---|
40 | <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="validation_error.html#id2340623-bb">set_option_name</a>(<span class="bold"><strong>const</strong></span> std::string &) ; |
---|
41 | |
---|
42 | <span class="emphasis"><em>// <a href="validation_error.html#id2524868-bb">private member functions</a></em></span> |
---|
43 | <span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a href="validation_error.html#id2371265-bb">what</a>() <span class="bold"><strong>const</strong></span>; |
---|
44 | };</pre></div> |
---|
45 | <div class="refsect1" lang="en"> |
---|
46 | <a name="id2719165"></a><h2>Description</h2> |
---|
47 | <p>Class thrown when value of option is incorrect. </p> |
---|
48 | <div class="refsect2" lang="en"> |
---|
49 | <a name="id2719171"></a><h3> |
---|
50 | <a name="validation_errorconstruct-copy-destruct"></a><code class="computeroutput">validation_error</code> construct/copy/destruct</h3> |
---|
51 | <div class="orderedlist"><ol type="1"> |
---|
52 | <li><pre class="literallayout"><a name="id2524851-bb"></a>validation_error(<span class="bold"><strong>const</strong></span> std::string & what);</pre></li> |
---|
53 | <li><pre class="literallayout"><a name="id2524865-bb"></a>~validation_error();</pre></li> |
---|
54 | </ol></div> |
---|
55 | </div> |
---|
56 | <div class="refsect2" lang="en"> |
---|
57 | <a name="id2719226"></a><h3> |
---|
58 | <a name="id2340618-bb"></a><code class="computeroutput">validation_error</code> public member functions</h3> |
---|
59 | <div class="orderedlist"><ol type="1"><li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2340623-bb"></a>set_option_name(<span class="bold"><strong>const</strong></span> std::string & option) ;</pre></li></ol></div> |
---|
60 | </div> |
---|
61 | <div class="refsect2" lang="en"> |
---|
62 | <a name="id2719271"></a><h3> |
---|
63 | <a name="id2524868-bb"></a><code class="computeroutput">validation_error</code> private member functions</h3> |
---|
64 | <div class="orderedlist"><ol type="1"><li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a name="id2371265-bb"></a>what() <span class="bold"><strong>const</strong></span>;</pre></li></ol></div> |
---|
65 | </div> |
---|
66 | </div> |
---|
67 | </div> |
---|
68 | <table width="100%"><tr> |
---|
69 | <td align="left"></td> |
---|
70 | <td align="right"><small>Copyright © 2002-2004 Vladimir Prus</small></td> |
---|
71 | </tr></table> |
---|
72 | <hr> |
---|
73 | <div class="spirit-nav"> |
---|
74 | <a accesskey="p" href="multiple_occurrences.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id2399042"><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="invalid_option_value.html"><img src="images/next.png" alt="Next"></a> |
---|
75 | </div> |
---|
76 | </body> |
---|
77 | </html> |
---|