diff options
Diffstat (limited to 'doc/html/validation_error.html')
-rw-r--r-- | doc/html/validation_error.html | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/doc/html/validation_error.html b/doc/html/validation_error.html new file mode 100644 index 0000000000..92149ec034 --- /dev/null +++ b/doc/html/validation_error.html @@ -0,0 +1,77 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>Class validation_error</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="program_options/reference.html#id696710" title="Header <boost/program_options/errors.hpp>"> +<link rel="prev" href="unknown_option.html" title="Class unknown_option"> +<link rel="next" href="basic_option.html" title="Class template basic_option"> +</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="unknown_option.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id696710"><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="basic_option.html"><img src="images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="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="bold"><strong>class</strong></span> validation_error : <span class="bold"><strong>public</strong></span> boost::program_options::error { +<span class="bold"><strong>public</strong></span>: + <span class="emphasis"><em>// <a href="validation_error.html#validation_errorconstruct-copy-destruct">construct/copy/destruct</a></em></span> + <a href="validation_error.html#id655362-bb">validation_error</a>(<span class="bold"><strong>const</strong></span> std::string &); + <a href="validation_error.html#id687727-bb">~validation_error</a>(); + + <span class="emphasis"><em>// <a href="validation_error.html#id1076230-bb">public member functions</a></em></span> + <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="validation_error.html#id964601-bb">set_option_name</a>(<span class="bold"><strong>const</strong></span> std::string &) ; + + <span class="emphasis"><em>// <a href="validation_error.html#id687730-bb">private member functions</a></em></span> + <span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a href="validation_error.html#id826784-bb">what</a>() <span class="bold"><strong>const</strong></span>; +};</pre></div> +<div class="refsect1" lang="en"> +<a name="id1251729"></a><h2>Description</h2> +<p>Class thrown when value of option is incorrect. </p> +<div class="refsect2" lang="en"> +<a name="id1251736"></a><h3> +<a name="validation_errorconstruct-copy-destruct"></a><code class="computeroutput">validation_error</code> construct/copy/destruct</h3> +<div class="orderedlist"><ol type="1"> +<li><pre class="literallayout"><a name="id655362-bb"></a>validation_error(<span class="bold"><strong>const</strong></span> std::string & what);</pre></li> +<li><pre class="literallayout"><a name="id687727-bb"></a>~validation_error();</pre></li> +</ol></div> +</div> +<div class="refsect2" lang="en"> +<a name="id1251790"></a><h3> +<a name="id1076230-bb"></a><code class="computeroutput">validation_error</code> public member functions</h3> +<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id964601-bb"></a>set_option_name(<span class="bold"><strong>const</strong></span> std::string & option) ;</pre></li></ol></div> +</div> +<div class="refsect2" lang="en"> +<a name="id1251835"></a><h3> +<a name="id687730-bb"></a><code class="computeroutput">validation_error</code> private member functions</h3> +<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="id826784-bb"></a>what() <span class="bold"><strong>const</strong></span>;</pre></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"><small>Copyright © 2002-2004 Vladimir Prus</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="unknown_option.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id696710"><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="basic_option.html"><img src="images/next.png" alt="Next"></a> +</div> +</body> +</html> |