| 1 | <html> |
|---|
| 2 | <head> |
|---|
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
|---|
| 4 | <title>Class template basic_option</title> |
|---|
| 5 | <link rel="stylesheet" href="boostbook.css" type="text/css"> |
|---|
| 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> |
|---|
| 7 | <link rel="start" href="index.html" title="The Boost C++ Libraries"> |
|---|
| 8 | <link rel="up" href="program_options/reference.html#id2359341" title="Header <boost/program_options/option.hpp>"> |
|---|
| 9 | <link rel="prev" href="invalid_command_line_style.html" title="Class invalid_command_line_style"> |
|---|
| 10 | <link rel="next" href="option_description.html" title="Class option_description"> |
|---|
| 11 | </head> |
|---|
| 12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
|---|
| 13 | <table cellpadding="2" width="100%"> |
|---|
| 14 | <td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td> |
|---|
| 15 | <td align="center"><a href="../../index.htm">Home</a></td> |
|---|
| 16 | <td align="center"><a href="../../libs/libraries.htm">Libraries</a></td> |
|---|
| 17 | <td align="center"><a href="../../people/people.htm">People</a></td> |
|---|
| 18 | <td align="center"><a href="../../more/faq.htm">FAQ</a></td> |
|---|
| 19 | <td align="center"><a href="../../more/index.htm">More</a></td> |
|---|
| 20 | </table> |
|---|
| 21 | <hr> |
|---|
| 22 | <div class="spirit-nav"> |
|---|
| 23 | <a accesskey="p" href="invalid_command_line_style.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id2359341"><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="option_description.html"><img src="images/next.png" alt="Next"></a> |
|---|
| 24 | </div> |
|---|
| 25 | <div class="refentry" lang="en"> |
|---|
| 26 | <a name="basic_option"></a><div class="titlepage"></div> |
|---|
| 27 | <div class="refnamediv"> |
|---|
| 28 | <h2><span class="refentrytitle">Class template basic_option</span></h2> |
|---|
| 29 | <p>boost::program_options::basic_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="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> charT> |
|---|
| 33 | <span class="bold"><strong>class</strong></span> basic_option { |
|---|
| 34 | <span class="bold"><strong>public</strong></span>: |
|---|
| 35 | <span class="emphasis"><em>// <a href="basic_option.html#basic_optionconstruct-copy-destruct">construct/copy/destruct</a></em></span> |
|---|
| 36 | <a href="basic_option.html#id2350517-bb">basic_option</a>(); |
|---|
| 37 | <a href="basic_option.html#id2350519-bb">basic_option</a>(<span class="bold"><strong>const</strong></span> std::string &, <span class="bold"><strong>const</strong></span> std::vector< std::string > &); |
|---|
| 38 | |
|---|
| 39 | <span class="emphasis"><em>// <a href="basic_option.html#id2350512-bb">public member functions</a></em></span> |
|---|
| 40 | |
|---|
| 41 | std::string string_key; |
|---|
| 42 | int position_key; |
|---|
| 43 | std::vector< std::basic_string< charT > > value; |
|---|
| 44 | std::vector< std::basic_string< charT > > original_tokens; |
|---|
| 45 | bool unregistered; |
|---|
| 46 | };</pre></div> |
|---|
| 47 | <div class="refsect1" lang="en"> |
|---|
| 48 | <a name="id2720364"></a><h2>Description</h2> |
|---|
| 49 | <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> |
|---|
| 50 | <div class="refsect2" lang="en"> |
|---|
| 51 | <a name="id2720375"></a><h3> |
|---|
| 52 | <a name="basic_optionconstruct-copy-destruct"></a><code class="computeroutput">basic_option</code> construct/copy/destruct</h3> |
|---|
| 53 | <div class="orderedlist"><ol type="1"> |
|---|
| 54 | <li><pre class="literallayout"><a name="id2350517-bb"></a>basic_option();</pre></li> |
|---|
| 55 | <li><pre class="literallayout"><a name="id2350519-bb"></a>basic_option(<span class="bold"><strong>const</strong></span> std::string & string_key, |
|---|
| 56 | <span class="bold"><strong>const</strong></span> std::vector< std::string > & value);</pre></li> |
|---|
| 57 | </ol></div> |
|---|
| 58 | </div> |
|---|
| 59 | <div class="refsect2" lang="en"> |
|---|
| 60 | <a name="id2720436"></a><h3> |
|---|
| 61 | <a name="id2350512-bb"></a><code class="computeroutput">basic_option</code> public member functions</h3> |
|---|
| 62 | <div class="orderedlist"><ol type="1"></ol></div> |
|---|
| 63 | </div> |
|---|
| 64 | </div> |
|---|
| 65 | </div> |
|---|
| 66 | <table width="100%"><tr> |
|---|
| 67 | <td align="left"></td> |
|---|
| 68 | <td align="right"><small>Copyright © 2002-2004 Vladimir Prus</small></td> |
|---|
| 69 | </tr></table> |
|---|
| 70 | <hr> |
|---|
| 71 | <div class="spirit-nav"> |
|---|
| 72 | <a accesskey="p" href="invalid_command_line_style.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id2359341"><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="option_description.html"><img src="images/next.png" alt="Next"></a> |
|---|
| 73 | </div> |
|---|
| 74 | </body> |
|---|
| 75 | </html> |
|---|
