doc/html/boost/program_options/basic_parsed_options.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template basic_parsed_options</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.parsers_hpp" title="Header &lt;boost/program_options/parsers.hpp&gt;">
   9 <link rel="prev" href="duplicate_option_error.html" title="Class duplicate_option_error">
  10 <link rel="next" href="basic_parsed_o_idp41259792.html" title="Class basic_parsed_options&lt;wchar_t&gt;">
  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="duplicate_option_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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_parsed_o_idp41259792.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.program_options.basic_parsed_options"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template basic_parsed_options</span></h2>
  29 <p>boost::program_options::basic_parsed_options</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.parsers_hpp" title="Header &lt;boost/program_options/parsers.hpp&gt;">boost/program_options/parsers.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> charT<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_optionsconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <span class="keyword">explicit</span> <a class="link" href="basic_parsed_options.html#idp45505856-bb"><span class="identifier">basic_parsed_options</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</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>
  39
  40   <span class="comment">// <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_optionspublic-data-members">public data members</a></span>
  41   <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <a class="link" href="basic_option.html" title="Class template basic_option">basic_option</a><span class="special">&lt;</span> <span class="identifier">charT</span> <span class="special">&gt;</span> <span class="special">&gt;</span> <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_options.options"><span class="identifier">options</span></a><span class="special">;</span>
  42   <span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_options.description"><span class="identifier">description</span></a><span class="special">;</span>
  43   <span class="keyword">int</span> <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_options.m_options_prefix"><span class="identifier">m_options_prefix</span></a><span class="special">;</span>
  44 <span class="special">}</span><span class="special">;</span></pre></div>
  45 <div class="refsect1">
  46 <a name="idp345886448"></a><h2>Description</h2>
  47 <p>Results of parsing an input source. The primary use of this class is passing information from parsers component to value storage component. This class does not makes much sense itself. </p>
  48 <div class="refsect2">
  49 <a name="idp345887328"></a><h3>
  50 <a name="boost.program_options.basic_parsed_optionsconstruct-copy-destruct"></a><code class="computeroutput">basic_parsed_options</code>
  51         public
  52        construct/copy/destruct</h3>
  53 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idp45505856-bb"></a><span class="identifier">basic_parsed_options</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> xdescription<span class="special">,</span>
  54                               <span class="keyword">int</span> options_prefix <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
  55 </div>
  56 <div class="refsect2">
  57 <a name="idp345898752"></a><h3>
  58 <a name="boost.program_options.basic_parsed_optionspublic-data-members"></a><code class="computeroutput">basic_parsed_options</code>
  59         public
  60        public data members</h3>
  61 <div class="orderedlist"><ol class="orderedlist" type="1">
  62 <li class="listitem">
  63 <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <a class="link" href="basic_option.html" title="Class template basic_option">basic_option</a><span class="special">&lt;</span> <span class="identifier">charT</span> <span class="special">&gt;</span> <span class="special">&gt;</span> <a name="boost.program_options.basic_parsed_options.options"></a><span class="identifier">options</span><span class="special">;</span></pre>
  64 <p>Options found in the source. </p>
  65 </li>
  66 <li class="listitem">
  67 <pre class="literallayout"><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> <a name="boost.program_options.basic_parsed_options.description"></a><span class="identifier">description</span><span class="special">;</span></pre>
  68 <p>Options description that was used for parsing. Parsers should return pointer to the instance of <a class="link" href="option_description.html" title="Class option_description">option_description</a> passed to them, and issues of lifetime are up to the caller. Can be NULL. </p>
  69 </li>
  70 <li class="listitem">
  71 <pre class="literallayout"><span class="keyword">int</span> <a name="boost.program_options.basic_parsed_options.m_options_prefix"></a><span class="identifier">m_options_prefix</span><span class="special">;</span></pre>
  72 <p>Mainly used for the diagnostic messages in exceptions. The canonical option prefix for the parser which generated these results, depending on the settings for basic_command_line_parser::style() or cmdline::style(). In order of precedence of command_line_style enums: allow_long allow_long_disguise allow_dash_for_short allow_slash_for_short </p>
  73 </li>
  74 </ol></div>
  75 </div>
  76 <div class="refsect2">
  77 <a name="idp345919744"></a><h3>Specializations</h3>
  78 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a class="link" href="basic_parsed_o_idp41259792.html" title="Class basic_parsed_options&lt;wchar_t&gt;">Class basic_parsed_options&lt;wchar_t&gt;</a></p></li></ul></div>
  79 </div>
  80 </div>
  81 </div>
  82 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  83 <td align="left"></td>
  84 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0.
  85       (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at
  86       <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  87       </p>
  88 </div></td>
  89 </tr></table>
  90 <hr>
  91 <div class="spirit-nav">
  92 <a accesskey="p" href="duplicate_option_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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_parsed_o_idp41259792.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  93 </div>
  94 </body>
  95 </html>