diff options
Diffstat (limited to 'doc/html/boost/program_options/basic_pa_idm45507044853824.html')
| -rw-r--r-- | doc/html/boost/program_options/basic_pa_idm45507044853824.html | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/doc/html/boost/program_options/basic_pa_idm45507044853824.html b/doc/html/boost/program_options/basic_pa_idm45507044853824.html new file mode 100644 index 0000000000..94ad50e85a --- /dev/null +++ b/doc/html/boost/program_options/basic_pa_idm45507044853824.html @@ -0,0 +1,97 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class basic_parsed_options<wchar_t></title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> +<link rel="prev" href="basic_parsed_options.html" title="Class template basic_parsed_options"> +<link rel="next" href="collect_unrecognized_mode.html" title="Type collect_unrecognized_mode"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="basic_parsed_options.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="collect_unrecognized_mode.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.program_options.basic_pa_idm45507044853824"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class basic_parsed_options<wchar_t></span></h2> +<p>boost::program_options::basic_parsed_options<wchar_t></p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<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.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> + +</span> +<span class="keyword">class</span> <a class="link" href="basic_pa_idm45507044853824.html" title="Class basic_parsed_options<wchar_t>">basic_parsed_options</a><span class="special"><</span><span class="keyword">wchar_t</span><span class="special">></span> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// <a class="link" href="basic_pa_idm45507044853824.html#boost.program_options.basic_pa_idm45507044853824construct-copy-destruct">construct/copy/destruct</a></span> + <span class="keyword">explicit</span> <a class="link" href="basic_pa_idm45507044853824.html#idm45507102070480-bb"><span class="identifier">basic_parsed_options</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="basic_pa_idm45507044853824.html#boost.program_options.basic_pa_idm45507044853824public-data-members">public data members</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <a class="link" href="basic_option.html" title="Class template basic_option">basic_option</a><span class="special"><</span> <span class="keyword">wchar_t</span> <span class="special">></span> <span class="special">></span> <span class="identifier">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> <span class="identifier">description</span><span class="special">;</span> + <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <a class="link" href="basic_pa_idm45507044853824.html#boost.program_options.basic_pa_idm45507044853824.utf8_encoded_options"><span class="identifier">utf8_encoded_options</span></a><span class="special">;</span> + <span class="keyword">int</span> <a class="link" href="basic_pa_idm45507044853824.html#boost.program_options.basic_pa_idm45507044853824.m_options_prefix"><span class="identifier">m_options_prefix</span></a><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idm45555215502624"></a><h2>Description</h2> +<p>Specialization of <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a> which:</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p>provides convenient conversion from <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options<char></a></p></li> +<li class="listitem"><p>stores the passed char-based options for later use. </p></li> +</ul></div> +<p> +</p> +<div class="refsect2"> +<a name="idm45555215498992"></a><h3> +<a name="boost.program_options.basic_pa_idm45507044853824construct-copy-destruct"></a><code class="computeroutput">basic_parsed_options</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45507102070480-bb"></a><span class="identifier">basic_parsed_options</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span> po<span class="special">)</span><span class="special">;</span></pre> +<p>Constructs wrapped options from options in UTF8 encoding. </p> +</li></ol></div> +</div> +<div class="refsect2"> +<a name="idm45555215487920"></a><h3> +<a name="boost.program_options.basic_pa_idm45507044853824public-data-members"></a><code class="computeroutput">basic_parsed_options</code> + public + public data members</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <a name="boost.program_options.basic_pa_idm45507044853824.utf8_encoded_options"></a><span class="identifier">utf8_encoded_options</span><span class="special">;</span></pre> +<p>Stores UTF8 encoded options that were passed to constructor, to avoid reverse conversion in some cases. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">int</span> <a name="boost.program_options.basic_pa_idm45507044853824.m_options_prefix"></a><span class="identifier">m_options_prefix</span><span class="special">;</span></pre> +<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> +</li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="basic_parsed_options.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="collect_unrecognized_mode.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |