1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Class validation_error</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> 10<link rel="prev" href="unknown_option.html" title="Class unknown_option"> 11<link rel="next" href="basic_option.html" title="Class template basic_option"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="unknown_option.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="basic_option.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.program_options.validation_error"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class validation_error</span></h2> 30<p>boost::program_options::validation_error</p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<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>> 34 35</span> 36<span class="keyword">class</span> <a class="link" href="validation_error.html" title="Class validation_error">validation_error</a> <span class="special">:</span> 37 <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> 38<span class="special">{</span> 39<span class="keyword">public</span><span class="special">:</span> 40 41 <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, 42 at_least_one_value_required, invalid_bool_value, 43 invalid_option_value, invalid_option <span class="special">}</span><span class="special">;</span> 44 <span class="comment">// <a class="link" href="validation_error.html#boost.program_options.validation_errorconstruct-copy-destruct">construct/copy/destruct</a></span> 45 <a class="link" href="validation_error.html#id-1_3_31_9_5_1_1_17_5-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> 46 <span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> 47 <a class="link" href="validation_error.html#id-1_3_31_9_5_1_1_17_6-bb"><span class="special">~</span><span class="identifier">validation_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 48 49 <span class="comment">// <a class="link" href="validation_error.html#id-1_3_31_9_5_1_1_17_4-bb">public member functions</a></span> 50 <span class="identifier">kind_t</span> <a class="link" href="validation_error.html#id-1_3_31_9_5_1_1_17_4_1-bb"><span class="identifier">kind</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 51 52 <span class="comment">// <a class="link" href="validation_error.html#id-1_3_31_9_5_1_1_17_7-bb">protected member functions</a></span> 53 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="validation_error.html#id-1_3_31_9_5_1_1_17_7_1-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> 54<span class="special">}</span><span class="special">;</span></pre></div> 55<div class="refsect1"> 56<a name="id-1.3.31.9.6.19.4"></a><h2>Description</h2> 57<p>Class thrown when value of option is incorrect. </p> 58<div class="refsect2"> 59<a name="id-1.3.31.9.6.19.4.3"></a><h3> 60<a name="boost.program_options.validation_errorconstruct-copy-destruct"></a><code class="computeroutput">validation_error</code> 61 public 62 construct/copy/destruct</h3> 63<div class="orderedlist"><ol class="orderedlist" type="1"> 64<li class="listitem"><pre class="literallayout"><a name="id-1_3_31_9_5_1_1_17_5-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> 65 <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> 66 <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> 67<li class="listitem"><pre class="literallayout"><a name="id-1_3_31_9_5_1_1_17_6-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> 68</ol></div> 69</div> 70<div class="refsect2"> 71<a name="id-1.3.31.9.6.19.4.4"></a><h3> 72<a name="id-1_3_31_9_5_1_1_17_4-bb"></a><code class="computeroutput">validation_error</code> public member functions</h3> 73<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="identifier">kind_t</span> <a name="id-1_3_31_9_5_1_1_17_4_1-bb"></a><span class="identifier">kind</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div> 74</div> 75<div class="refsect2"> 76<a name="id-1.3.31.9.6.19.4.5"></a><h3> 77<a name="id-1_3_31_9_5_1_1_17_7-bb"></a><code class="computeroutput">validation_error</code> protected member functions</h3> 78<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 79<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id-1_3_31_9_5_1_1_17_7_1-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> 80<p>Used to convert kind_t to a related error text </p> 81</li></ol></div> 82</div> 83</div> 84</div> 85<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 86<td align="left"></td> 87<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. 88 (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at 89 <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 90 </p> 91</div></td> 92</tr></table> 93<hr> 94<div class="spirit-nav"> 95<a accesskey="p" href="unknown_option.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="basic_option.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 96</div> 97</body> 98</html> 99
