diff options
Diffstat (limited to 'doc/html/boost/program_options/validation_error.html')
| -rw-r--r--[-rwxr-xr-x] | doc/html/boost/program_options/validation_error.html | 50 |
1 files changed, 20 insertions, 30 deletions
diff --git a/doc/html/boost/program_options/validation_error.html b/doc/html/boost/program_options/validation_error.html index 84abd8e13a..7a7a1c747a 100755..100644 --- a/doc/html/boost/program_options/validation_error.html +++ b/doc/html/boost/program_options/validation_error.html @@ -6,7 +6,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <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 <boost/program_options/errors.hpp>"> -<link rel="prev" href="multiple_occurrences.html" title="Class multiple_occurrences"> +<link rel="prev" href="invalid_command_l_id794968.html" title="Class invalid_command_line_syntax"> <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"> @@ -20,7 +20,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="multiple_occurrences.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_option_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="invalid_command_l_id794968.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_option_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.validation_error"></a><div class="titlepage"></div> @@ -32,52 +32,42 @@ <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="validation_error.html" title="Class validation_error">validation_error</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">error</span> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="validation_error.html" title="Class validation_error">validation_error</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">error_with_option_name</span> +<span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="keyword">enum</span> <a name="boost.program_options.validation_error.kind_t"></a>kind_t <span class="special">{</span> multiple_values_not_allowed = 30, at_least_one_value_required, invalid_bool_value, invalid_option_value, invalid_option <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="validation_error.html#boost.program_options.validation_errorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="validation_error.html#id1149976-bb"><span class="identifier">validation_error</span></a><span class="special">(</span><span class="identifier">kind_t</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">&</span> <span class="special">=</span> <span class="string">""</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">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="validation_error.html#id1149997-bb"><span class="special">~</span><span class="identifier">validation_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="validation_error.html#id1096866-bb"><span class="identifier">validation_error</span></a><span class="special">(</span><span class="identifier">kind_t</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">&</span> <span class="special">=</span> <span class="string">""</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">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> + <span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="validation_error.html#id1096894-bb"><span class="special">~</span><span class="identifier">validation_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="validation_error.html#id1070418-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="validation_error.html#id1070421-bb"><span class="identifier">set_option_name</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">&</span><span class="special">)</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">&</span> <a class="link" href="validation_error.html#id1070433-bb"><span class="identifier">get_option_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="validation_error.html#id1070440-bb"><span class="identifier">what</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="validation_error.html#id1149998-bb">protected static functions</a></span> - <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="validation_error.html#id1150001-bb"><span class="identifier">error_message</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="validation_error.html#id1096895-bb">protected member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="validation_error.html#id1096898-bb"><span class="identifier">get_template</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="id2509162"></a><h2>Description</h2> +<a name="id2561592"></a><h2>Description</h2> <p>Class thrown when value of option is incorrect. </p> <div class="refsect2"> -<a name="id2509168"></a><h3> +<a name="id2561599"></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="id1149976-bb"></a><span class="identifier">validation_error</span><span class="special">(</span><span class="identifier">kind_t</span> kind<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">&</span> option_value <span class="special">=</span> <span class="string">""</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">&</span> option_name <span class="special">=</span> <span class="string">""</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="id1149997-bb"></a><span class="special">~</span><span class="identifier">validation_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -</ol></div> -</div> -<div class="refsect2"> -<a name="id2509337"></a><h3> -<a name="id1070418-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="keyword">void</span> <a name="id1070421-bb"></a><span class="identifier">set_option_name</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">&</span> option<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="id1070433-bb"></a><span class="identifier">get_option_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="id1070440-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="id1096866-bb"></a><span class="identifier">validation_error</span><span class="special">(</span><span class="identifier">kind_t</span> kind<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">&</span> option_name <span class="special">=</span> <span class="string">""</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">&</span> original_token <span class="special">=</span> <span class="string">""</span><span class="special">,</span> + <span class="keyword">int</span> option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="id1096894-bb"></a><span class="special">~</span><span class="identifier">validation_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="id2509528"></a><h3> -<a name="id1149998-bb"></a><code class="computeroutput">validation_error</code> protected static functions</h3> +<a name="id2561789"></a><h3> +<a name="id1096895-bb"></a><code class="computeroutput">validation_error</code> protected member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id1150001-bb"></a><span class="identifier">error_message</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id1096898-bb"></a><span class="identifier">get_template</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">)</span><span class="special">;</span></pre> <p>Used to convert kind_t to a related error text </p> </li></ol></div> </div> @@ -93,7 +83,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="multiple_occurrences.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_option_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="invalid_command_l_id794968.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_option_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |