basic_option.html 4.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  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.68.1">
  7. <link rel="start" href="index.html" title="The Boost C++ Libraries">
  8. <link rel="up" href="program_options/reference.html#id864937" title="Header &lt;boost/program_options/option.hpp&gt;">
  9. <link rel="prev" href="validation_error.html" title="Class validation_error">
  10. <link rel="next" href="duplicate_option_error.html" title="Class duplicate_option_error">
  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="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>
  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 &#8212; </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>&lt;<span class="bold"><strong>typename</strong></span> charT&gt;
  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#id1114467-bb">basic_option</a>();
  37.   <a href="basic_option.html#id1042744-bb">basic_option</a>(<span class="bold"><strong>const</strong></span> std::string &amp;, <span class="bold"><strong>const</strong></span> std::vector&lt; std::string &gt; &amp;);
  38.   <span class="emphasis"><em>// <a href="basic_option.html#id1004663-bb">public member functions</a></em></span>
  39.   std::string string_key;
  40.   int position_key;
  41.   std::vector&lt; std::basic_string&lt; charT &gt; &gt; value;
  42.   bool unregistered;
  43. };</pre></div>
  44. <div class="refsect1" lang="en">
  45. <a name="id1252076"></a><h2>Description</h2>
  46. <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>
  47. <div class="refsect2" lang="en">
  48. <a name="id1252087"></a><h3>
  49. <a name="basic_optionconstruct-copy-destruct"></a><code class="computeroutput">basic_option</code> construct/copy/destruct</h3>
  50. <div class="orderedlist"><ol type="1">
  51. <li><pre class="literallayout"><a name="id1114467-bb"></a>basic_option();</pre></li>
  52. <li><pre class="literallayout"><a name="id1042744-bb"></a>basic_option(<span class="bold"><strong>const</strong></span> std::string &amp; string_key,
  53.              <span class="bold"><strong>const</strong></span> std::vector&lt; std::string &gt; &amp; value);</pre></li>
  54. </ol></div>
  55. </div>
  56. <div class="refsect2" lang="en">
  57. <a name="id1252147"></a><h3>
  58. <a name="id1004663-bb"></a><code class="computeroutput">basic_option</code> public member functions</h3>
  59. <div class="orderedlist"><ol type="1"></ol></div>
  60. </div>
  61. </div>
  62. </div>
  63. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  64. <td align="left"></td>
  65. <td align="right"><small>Copyright © 2002-2004 Vladimir Prus</small></td>
  66. </tr></table>
  67. <hr>
  68. <div class="spirit-nav">
  69. <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>
  70. </div>
  71. </body>
  72. </html>
粤ICP备19079148号