doc/html/boost/program_options/ambiguous_option.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class ambiguous_option</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header &lt;boost/program_options/errors.hpp&gt;">
   9 <link rel="prev" href="unknown_option.html" title="Class unknown_option">
  10 <link rel="next" href="invalid_syntax.html" title="Class invalid_syntax">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <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="invalid_syntax.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.program_options.ambiguous_option"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class ambiguous_option</span></h2>
  29 <p>boost::program_options::ambiguous_option</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"><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;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="ambiguous_option.html" title="Class ambiguous_option">ambiguous_option</a> <span class="special">:</span>
  36   <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_no_option_name</span>
  37 <span class="special">{</span>
  38 <span class="keyword">public</span><span class="special">:</span>
  39   <span class="comment">// <a class="link" href="ambiguous_option.html#boost.program_options.ambiguous_optionconstruct-copy-destruct">construct/copy/destruct</a></span>
  40   <a class="link" href="ambiguous_option.html#idp218437216-bb"><span class="identifier">ambiguous_option</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  41   <a class="link" href="ambiguous_option.html#idp112894320-bb"><span class="special">~</span><span class="identifier">ambiguous_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="ambiguous_option.html#idp148433424-bb">public member functions</a></span>
  44   <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <a class="link" href="ambiguous_option.html#idp106082912-bb"><span class="identifier">alternatives</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  45
  46   <span class="comment">// <a class="link" href="ambiguous_option.html#idp112894608-bb">protected member functions</a></span>
  47   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="ambiguous_option.html#idp157113152-bb"><span class="identifier">substitute_placeholders</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">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  48 <span class="special">}</span><span class="special">;</span></pre></div>
  49 <div class="refsect1">
  50 <a name="idp344439168"></a><h2>Description</h2>
  51 <p>Class thrown when there's ambiguity amoung several possible options. </p>
  52 <div class="refsect2">
  53 <a name="idp344439920"></a><h3>
  54 <a name="boost.program_options.ambiguous_optionconstruct-copy-destruct"></a><code class="computeroutput">ambiguous_option</code>
  55         public
  56        construct/copy/destruct</h3>
  57 <div class="orderedlist"><ol class="orderedlist" type="1">
  58 <li class="listitem"><pre class="literallayout"><a name="idp218437216-bb"></a><span class="identifier">ambiguous_option</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&gt;</span> <span class="special">&amp;</span> xalternatives<span class="special">)</span><span class="special">;</span></pre></li>
  59 <li class="listitem"><pre class="literallayout"><a name="idp112894320-bb"></a><span class="special">~</span><span class="identifier">ambiguous_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  60 </ol></div>
  61 </div>
  62 <div class="refsect2">
  63 <a name="idp344456272"></a><h3>
  64 <a name="idp148433424-bb"></a><code class="computeroutput">ambiguous_option</code> public member functions</h3>
  65 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <a name="idp106082912-bb"></a><span class="identifier">alternatives</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div>
  66 </div>
  67 <div class="refsect2">
  68 <a name="idp344468928"></a><h3>
  69 <a name="idp112894608-bb"></a><code class="computeroutput">ambiguous_option</code> protected member functions</h3>
  70 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  71 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp157113152-bb"></a><span class="identifier">substitute_placeholders</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> error_template<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  72 <p>Makes all substitutions using the template </p>
  73 </li></ol></div>
  74 </div>
  75 </div>
  76 </div>
  77 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  78 <td align="left"></td>
  79 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0.
  80       (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at
  81       <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  82       </p>
  83 </div></td>
  84 </tr></table>
  85 <hr>
  86 <div class="spirit-nav">
  87 <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="invalid_syntax.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  88 </div>
  89 </body>
  90 </html>