| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374 |
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>Class template basic_option</title>
- <link rel="stylesheet" href="boostbook.css" type="text/css">
- <meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
- <link rel="start" href="index.html" title="The Boost C++ Libraries">
- <link rel="up" href="program_options/reference.html#id864937" title="Header <boost/program_options/option.hpp>">
- <link rel="prev" href="validation_error.html" title="Class validation_error">
- <link rel="next" href="duplicate_option_error.html" title="Class duplicate_option_error">
- </head>
- <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
- <table cellpadding="2" width="100%">
- <td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
- <td align="center"><a href="../../index.htm">Home</a></td>
- <td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
- <td align="center"><a href="../../people/people.htm">People</a></td>
- <td align="center"><a href="../../more/faq.htm">FAQ</a></td>
- <td align="center"><a href="../../more/index.htm">More</a></td>
- </table>
- <hr>
- <div class="spirit-nav">
- <a accesskey="p" href="validation_error.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id864937"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="duplicate_option_error.html"><img src="images/next.png" alt="Next"></a>
- </div>
- <div class="refentry" lang="en">
- <a name="basic_option"></a><div class="titlepage"></div>
- <div class="refnamediv">
- <h2><span class="refentrytitle">Class template basic_option</span></h2>
- <p>boost::program_options::basic_option — </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="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> charT>
- <span class="bold"><strong>class</strong></span> basic_option {
- <span class="bold"><strong>public</strong></span>:
- <span class="emphasis"><em>// <a href="basic_option.html#basic_optionconstruct-copy-destruct">construct/copy/destruct</a></em></span>
- <a href="basic_option.html#id1114467-bb">basic_option</a>();
- <a href="basic_option.html#id1042744-bb">basic_option</a>(<span class="bold"><strong>const</strong></span> std::string &, <span class="bold"><strong>const</strong></span> std::vector< std::string > &);
- <span class="emphasis"><em>// <a href="basic_option.html#id1004663-bb">public member functions</a></em></span>
- std::string string_key;
- int position_key;
- std::vector< std::basic_string< charT > > value;
- bool unregistered;
- };</pre></div>
- <div class="refsect1" lang="en">
- <a name="id1252076"></a><h2>Description</h2>
- <p>Option found in input source. Contains a key and a value. The key, in turn, can be a string (name of an option), or an integer (position in input source) -- in case no name is specified. The latter is only possible for command line. The template parameter specifies the type of char used for storing the option's value. </p>
- <div class="refsect2" lang="en">
- <a name="id1252087"></a><h3>
- <a name="basic_optionconstruct-copy-destruct"></a><code class="computeroutput">basic_option</code> construct/copy/destruct</h3>
- <div class="orderedlist"><ol type="1">
- <li><pre class="literallayout"><a name="id1114467-bb"></a>basic_option();</pre></li>
- <li><pre class="literallayout"><a name="id1042744-bb"></a>basic_option(<span class="bold"><strong>const</strong></span> std::string & string_key,
- <span class="bold"><strong>const</strong></span> std::vector< std::string > & value);</pre></li>
- </ol></div>
- </div>
- <div class="refsect2" lang="en">
- <a name="id1252147"></a><h3>
- <a name="id1004663-bb"></a><code class="computeroutput">basic_option</code> public member functions</h3>
- <div class="orderedlist"><ol type="1"></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"><small>Copyright © 2002-2004 Vladimir Prus</small></td>
- </tr></table>
- <hr>
- <div class="spirit-nav">
- <a accesskey="p" href="validation_error.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id864937"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="duplicate_option_error.html"><img src="images/next.png" alt="Next"></a>
- </div>
- </body>
- </html>
|