doc/html/boost/program_options/invalid_comma_idp682162800.html

   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=US-ASCII">
   5 <title>Class invalid_command_line_syntax</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 &lt;boost/program_options/errors.hpp&gt;">
  10 <link rel="prev" href="invalid_config_file_syntax.html" title="Class invalid_config_file_syntax">
  11 <link rel="next" href="validation_error.html" title="Class validation_error">
  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="invalid_config_file_syntax.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="validation_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.program_options.invalid_comma_idp682162800"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class invalid_command_line_syntax</span></h2>
  30 <p>boost::program_options::invalid_command_line_syntax</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: &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;
  34
  35 </span>
  36 <span class="keyword">class</span> <a class="link" href="invalid_comma_idp682162800.html" title="Class invalid_command_line_syntax">invalid_command_line_syntax</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">invalid_syntax</span>
  38 <span class="special">{</span>
  39 <span class="keyword">public</span><span class="special">:</span>
  40   <span class="comment">// <a class="link" href="invalid_comma_idp682162800.html#boost.program_options.invalid_comma_idp682162800construct-copy-destruct">construct/copy/destruct</a></span>
  41   <a class="link" href="invalid_comma_idp682162800.html#idp682164976-bb"><span class="identifier">invalid_command_line_syntax</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">&amp;</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span>
  42                               <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</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>
  43   <a class="link" href="invalid_comma_idp682162800.html#idp682168880-bb"><span class="special">~</span><span class="identifier">invalid_command_line_syntax</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  44 <span class="special">}</span><span class="special">;</span></pre></div>
  45 <div class="refsect1">
  46 <a name="idp437259392"></a><h2>Description</h2>
  47 <p>Class thrown when there are syntax errors in given command line </p>
  48 <div class="refsect2">
  49 <a name="idp437260064"></a><h3>
  50 <a name="boost.program_options.invalid_comma_idp682162800construct-copy-destruct"></a><code class="computeroutput">invalid_command_line_syntax</code>
  51         public
  52        construct/copy/destruct</h3>
  53 <div class="orderedlist"><ol class="orderedlist" type="1">
  54 <li class="listitem"><pre class="literallayout"><a name="idp682164976-bb"></a><span class="identifier">invalid_command_line_syntax</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">&amp;</span> option_name <span class="special">=</span> <span class="string">""</span><span class="special">,</span>
  55                             <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> original_token <span class="special">=</span> <span class="string">""</span><span class="special">,</span>
  56                             <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>
  57 <li class="listitem"><pre class="literallayout"><a name="idp682168880-bb"></a><span class="special">~</span><span class="identifier">invalid_command_line_syntax</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  58 </ol></div>
  59 </div>
  60 </div>
  61 </div>
  62 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  63 <td align="left"></td>
  64 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0.
  65       (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at
  66       <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  67       </p>
  68 </div></td>
  69 </tr></table>
  70 <hr>
  71 <div class="spirit-nav">
  72 <a accesskey="p" href="invalid_config_file_syntax.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="validation_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  73 </div>
  74 </body>
  75 </html>