Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/doc/html/program_options/reference.html @ 25

Last change on this file since 25 was 12, checked in by landauf, 17 years ago

added boost
File size: 22.2 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Reference</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.html" title="Chapter 7. Boost.Program_options">
9<link rel="prev" href="s06.html" title="Acknowledgements">
10<link rel="next" href="../id2358254.html" title="Type style_t">
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="s06.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../program_options.html"><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="../id2358254.html"><img src="../images/next.png" alt="Next"></a>
24</div>
25<div class="section" lang="en">
26<div class="titlepage"><div><div><h3 class="title">
27<a name="program_options.reference"></a>Reference</h3></div></div></div>
28<div class="toc"><dl>
29<dt><span class="section"><a href="reference.html#id2355176">Header &lt;boost/program_options/cmdline.hpp&gt;</a></span></dt>
30<dt><span class="section"><a href="reference.html#id2380073">Header &lt;boost/program_options/environment_iterator.hpp&gt;</a></span></dt>
31<dt><span class="section"><a href="reference.html#id2338601">Header &lt;boost/program_options/eof_iterator.hpp&gt;</a></span></dt>
32<dt><span class="section"><a href="reference.html#id2399042">Header &lt;boost/program_options/errors.hpp&gt;</a></span></dt>
33<dt><span class="section"><a href="reference.html#id2359341">Header &lt;boost/program_options/option.hpp&gt;</a></span></dt>
34<dt><span class="section"><a href="reference.html#id2473651">Header &lt;boost/program_options/options_description.hpp&gt;</a></span></dt>
35<dt><span class="section"><a href="reference.html#id2348797">Header &lt;boost/program_options/parsers.hpp&gt;</a></span></dt>
36<dt><span class="section"><a href="reference.html#id2525887">Header &lt;boost/program_options/positional_options.hpp&gt;</a></span></dt>
37<dt><span class="section"><a href="reference.html#id2379391">Header &lt;boost/program_options/value_semantic.hpp&gt;</a></span></dt>
38<dt><span class="section"><a href="reference.html#id2524541">Header &lt;boost/program_options/variables_map.hpp&gt;</a></span></dt>
39<dt><span class="section"><a href="reference.html#id2363464">Header &lt;boost/program_options/version.hpp&gt;</a></span></dt>
40</dl></div>
41<div class="section" lang="en">
42<div class="titlepage"><div><div><h4 class="title">
43<a name="id2355176"></a>Header &lt;<a href="../../../boost/program_options/cmdline.hpp" target="_top">boost/program_options/cmdline.hpp</a>&gt;</h4></div></div></div>
44<pre class="synopsis"><span class="bold"><strong>namespace</strong></span> boost {
45  <span class="bold"><strong>namespace</strong></span> program_options {
46    <span class="bold"><strong>namespace</strong></span> command_line_style {
47      <span class="bold"><strong>enum</strong></span> <a href="../id2358254.html" title="Type style_t">style_t</a>;
48    }
49  }
50}</pre>
51</div>
52<div class="section" lang="en">
53<div class="titlepage"><div><div><h4 class="title">
54<a name="id2380073"></a>Header &lt;<a href="../../../boost/program_options/environment_iterator.hpp" target="_top">boost/program_options/environment_iterator.hpp</a>&gt;</h4></div></div></div>
55<pre class="synopsis"><span class="bold"><strong>namespace</strong></span> boost {
56  <span class="bold"><strong>class</strong></span> <a href="../environment_iterator.html" title="Class environment_iterator">environment_iterator</a>;
57}</pre>
58</div>
59<div class="section" lang="en">
60<div class="titlepage"><div><div><h4 class="title">
61<a name="id2338601"></a>Header &lt;<a href="../../../boost/program_options/eof_iterator.hpp" target="_top">boost/program_options/eof_iterator.hpp</a>&gt;</h4></div></div></div>
62<pre class="synopsis"><span class="bold"><strong>namespace</strong></span> boost {
63  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Derived, <span class="bold"><strong>typename</strong></span> ValueType&gt; <span class="bold"><strong>class</strong></span> <a href="../eof_iterator.html" title="Class template eof_iterator">eof_iterator</a>;
64}</pre>
65</div>
66<div class="section" lang="en">
67<div class="titlepage"><div><div><h4 class="title">
68<a name="id2399042"></a>Header &lt;<a href="../../../boost/program_options/errors.hpp" target="_top">boost/program_options/errors.hpp</a>&gt;</h4></div></div></div>
69<pre class="synopsis"><span class="bold"><strong>namespace</strong></span> boost {
70  <span class="bold"><strong>namespace</strong></span> program_options {
71    <span class="bold"><strong>class</strong></span> <a href="../error.html" title="Class error">error</a>;
72    <span class="bold"><strong>class</strong></span> <a href="../invalid_syntax.html" title="Class invalid_syntax">invalid_syntax</a>;
73    <span class="bold"><strong>class</strong></span> <a href="../unknown_option.html" title="Class unknown_option">unknown_option</a>;
74    <span class="bold"><strong>class</strong></span> <a href="../ambiguous_option.html" title="Class ambiguous_option">ambiguous_option</a>;
75    <span class="bold"><strong>class</strong></span> <a href="../multiple_values.html" title="Class multiple_values">multiple_values</a>;
76    <span class="bold"><strong>class</strong></span> <a href="../multiple_occurrences.html" title="Class multiple_occurrences">multiple_occurrences</a>;
77    <span class="bold"><strong>class</strong></span> <a href="../validation_error.html" title="Class validation_error">validation_error</a>;
78    <span class="bold"><strong>class</strong></span> <a href="../invalid_option_value.html" title="Class invalid_option_value">invalid_option_value</a>;
79    <span class="bold"><strong>class</strong></span> <a href="../id2382392.html" title="Class too_many_positional_options_error">too_many_positional_options_error</a>;
80    <span class="bold"><strong>class</strong></span> <a href="../id2509958.html" title="Class too_few_positional_options_error">too_few_positional_options_error</a>;
81    <span class="bold"><strong>class</strong></span> <a href="../id2492742.html" title="Class invalid_command_line_syntax">invalid_command_line_syntax</a>;
82    <span class="bold"><strong>class</strong></span> <a href="../invalid_command_line_style.html" title="Class invalid_command_line_style">invalid_command_line_style</a>;
83  }
84}</pre>
85</div>
86<div class="section" lang="en">
87<div class="titlepage"><div><div><h4 class="title">
88<a name="id2359341"></a>Header &lt;<a href="../../../boost/program_options/option.hpp" target="_top">boost/program_options/option.hpp</a>&gt;</h4></div></div></div>
89<pre class="synopsis"><span class="bold"><strong>namespace</strong></span> boost {
90  <span class="bold"><strong>namespace</strong></span> program_options {
91    <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> charT&gt; <span class="bold"><strong>class</strong></span> <a href="../basic_option.html" title="Class template basic_option">basic_option</a>;
92
93    <span class="bold"><strong>typedef</strong></span> <a href="../basic_option.html" title="Class template basic_option">basic_option</a>&lt; <span class="bold"><strong>char</strong></span> &gt; option;
94    <span class="bold"><strong>typedef</strong></span> <a href="../basic_option.html" title="Class template basic_option">basic_option</a>&lt; <span class="bold"><strong>wchar_t</strong></span> &gt; woption;
95  }
96}</pre>
97</div>
98<div class="section" lang="en">
99<div class="titlepage"><div><div><h4 class="title">
100<a name="id2473651"></a>Header &lt;<a href="../../../boost/program_options/options_description.hpp" target="_top">boost/program_options/options_description.hpp</a>&gt;</h4></div></div></div>
101<pre class="synopsis"><span class="bold"><strong>namespace</strong></span> boost {
102  <span class="bold"><strong>namespace</strong></span> program_options {
103    <span class="bold"><strong>class</strong></span> <a href="../option_description.html" title="Class option_description">option_description</a>;
104    <span class="bold"><strong>class</strong></span> <a href="../id2411202.html" title="Class options_description_easy_init">options_description_easy_init</a>;
105    <span class="bold"><strong>class</strong></span> <a href="../options_description.html" title="Class options_description">options_description</a>;
106    <span class="bold"><strong>class</strong></span> <a href="../duplicate_option_error.html" title="Class duplicate_option_error">duplicate_option_error</a>;
107  }
108}</pre>
109</div>
110<div class="section" lang="en">
111<div class="titlepage"><div><div><h4 class="title">
112<a name="id2348797"></a>Header &lt;<a href="../../../boost/program_options/parsers.hpp" target="_top">boost/program_options/parsers.hpp</a>&gt;</h4></div></div></div>
113<pre class="synopsis"><span class="bold"><strong>namespace</strong></span> boost {
114  <span class="bold"><strong>namespace</strong></span> program_options {
115    <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> charT&gt; <span class="bold"><strong>class</strong></span> <a href="../basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a>;
116
117    <span class="bold"><strong>template</strong></span>&lt;&gt; <span class="bold"><strong>class</strong></span> <a href="../id2381437-bb.html" title="Class basic_parsed_options&lt;wchar_t&gt;">basic_parsed_options</a>&lt;<span class="bold"><strong>wchar_t</strong></span>&gt;;
118
119    <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> charT&gt; <span class="bold"><strong>class</strong></span> <a href="../basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a>;
120
121    <span class="bold"><strong>typedef</strong></span> <a href="../basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a>&lt; <span class="bold"><strong>char</strong></span> &gt; parsed_options;
122    <span class="bold"><strong>typedef</strong></span> <a href="../basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a>&lt; <span class="bold"><strong>wchar_t</strong></span> &gt; wparsed_options;
123    <span class="bold"><strong>typedef</strong></span> function1&lt; std::pair&lt; std::string, std::string &gt;, <span class="bold"><strong>const</strong></span> std::string &amp; &gt; ext_parser;
124    <span class="bold"><strong>typedef</strong></span> <a href="../basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a>&lt; <span class="bold"><strong>char</strong></span> &gt; command_line_parser;
125    <span class="bold"><strong>typedef</strong></span> <a href="../basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a>&lt; <span class="bold"><strong>wchar_t</strong></span> &gt; wcommand_line_parser;
126
127    <span class="bold"><strong>enum</strong></span> <a href="../id2348892.html" title="Type collect_unrecognized_mode">collect_unrecognized_mode</a>;
128    <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> charT&gt; 
129      <span class="type"><a href="../basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a>&lt; charT &gt;</span> 
130      <a href="../parse_command_line.html" title="Function template parse_command_line">parse_command_line</a>(<span class="bold"><strong>int</strong></span>, charT *, <span class="bold"><strong>const</strong></span> <a href="../options_description.html" title="Class options_description">options_description</a> &amp;, <span class="bold"><strong>int</strong></span> = 0,
131                         function1&lt; std::pair&lt; std::string, std::string &gt;, <span class="bold"><strong>const</strong></span> std::string &amp; &gt; = ext_parser());
132    <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> charT&gt; 
133      <span class="type">BOOST_PROGRAM_OPTIONS_DECL <a href="../basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a>&lt; charT &gt;</span> 
134      <a href="../parse_config_file.html" title="Function template parse_config_file">parse_config_file</a>(std::basic_istream&lt; charT &gt; &amp;,
135                        <span class="bold"><strong>const</strong></span> <a href="../options_description.html" title="Class options_description">options_description</a> &amp;);
136    <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> charT&gt; 
137      <span class="type">std::vector&lt; std::basic_string&lt; charT &gt; &gt;</span> 
138      <a href="../collect_unrecognized.html" title="Function template collect_unrecognized">collect_unrecognized</a>(<span class="bold"><strong>const</strong></span> std::vector&lt; <a href="../basic_option.html" title="Class template basic_option">basic_option</a>&lt; charT &gt; &gt; &amp;,
139                           <span class="bold"><strong>enum</strong></span> collect_unrecognized_mode);
140    <span class="type">BOOST_PROGRAM_OPTIONS_DECL parsed_options</span> 
141    <a href="../id2383787.html" title="Function parse_environment">parse_environment</a>(<span class="bold"><strong>const</strong></span> <a href="../options_description.html" title="Class options_description">options_description</a> &amp;,
142                      <span class="bold"><strong>const</strong></span> function1&lt; std::string, std::string &gt; &amp;);
143    <span class="type">BOOST_PROGRAM_OPTIONS_DECL parsed_options</span> 
144    <a href="../id2462174.html" title="Function parse_environment">parse_environment</a>(<span class="bold"><strong>const</strong></span> <a href="../options_description.html" title="Class options_description">options_description</a> &amp;, <span class="bold"><strong>const</strong></span> std::string &amp;);
145    <span class="type">BOOST_PROGRAM_OPTIONS_DECL parsed_options</span> 
146    <a href="../id2462174.html" title="Function parse_environment">parse_environment</a>(<span class="bold"><strong>const</strong></span> <a href="../options_description.html" title="Class options_description">options_description</a> &amp;, <span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *);
147  }
148}</pre>
149</div>
150<div class="section" lang="en">
151<div class="titlepage"><div><div><h4 class="title">
152<a name="id2525887"></a>Header &lt;<a href="../../../boost/program_options/positional_options.hpp" target="_top">boost/program_options/positional_options.hpp</a>&gt;</h4></div></div></div>
153<pre class="synopsis"><span class="bold"><strong>namespace</strong></span> boost {
154  <span class="bold"><strong>namespace</strong></span> program_options {
155    <span class="bold"><strong>class</strong></span> <a href="../id2525902.html" title="Class positional_options_description">positional_options_description</a>;
156  }
157}</pre>
158</div>
159<div class="section" lang="en">
160<div class="titlepage"><div><div><h4 class="title">
161<a name="id2379391"></a>Header &lt;<a href="../../../boost/program_options/value_semantic.hpp" target="_top">boost/program_options/value_semantic.hpp</a>&gt;</h4></div></div></div>
162<pre class="synopsis"><span class="bold"><strong>namespace</strong></span> boost {
163  <span class="bold"><strong>namespace</strong></span> program_options {
164    <span class="bold"><strong>class</strong></span> <a href="../value_semantic.html" title="Class value_semantic">value_semantic</a>;
165    <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> charT&gt; <span class="bold"><strong>class</strong></span> <a href="../id2284769.html" title="Class template value_semantic_codecvt_helper">value_semantic_codecvt_helper</a>;
166
167    <span class="bold"><strong>template</strong></span>&lt;&gt; <span class="bold"><strong>class</strong></span> <a href="../id2381778-bb.html" title="Class value_semantic_codecvt_helper&lt;char&gt;">value_semantic_codecvt_helper</a>&lt;<span class="bold"><strong>char</strong></span>&gt;;
168    <span class="bold"><strong>template</strong></span>&lt;&gt; <span class="bold"><strong>class</strong></span> <a href="../id2381519-bb.html" title="Class value_semantic_codecvt_helper&lt;wchar_t&gt;">value_semantic_codecvt_helper</a>&lt;<span class="bold"><strong>wchar_t</strong></span>&gt;;
169
170    <span class="bold"><strong>class</strong></span> <a href="../untyped_value.html" title="Class untyped_value">untyped_value</a>;
171    <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T, <span class="bold"><strong>typename</strong></span> charT = <span class="bold"><strong>char</strong></span>&gt; <span class="bold"><strong>class</strong></span> <a href="../typed_value.html" title="Class template typed_value">typed_value</a>;
172    <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T&gt; <span class="type"><a href="../typed_value.html" title="Class template typed_value">typed_value</a>&lt; T &gt; *</span> <a href="../value.html" title="Function value">value</a>();
173    <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T&gt; <span class="type"><a href="../typed_value.html" title="Class template typed_value">typed_value</a>&lt; T &gt; *</span> <a href="../value.html" title="Function value">value</a>(T *);
174    <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T&gt; <span class="type"><a href="../typed_value.html" title="Class template typed_value">typed_value</a>&lt; T, <span class="bold"><strong>wchar_t</strong></span> &gt; *</span> <a href="../wvalue.html" title="Function wvalue">wvalue</a>();
175    <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> T&gt; <span class="type"><a href="../typed_value.html" title="Class template typed_value">typed_value</a>&lt; T, <span class="bold"><strong>wchar_t</strong></span> &gt; *</span> <a href="../wvalue.html" title="Function wvalue">wvalue</a>(T *);
176    <span class="type">BOOST_PROGRAM_OPTIONS_DECL <a href="../typed_value.html" title="Class template typed_value">typed_value</a>&lt; <span class="bold"><strong>bool</strong></span> &gt; *</span> <a href="../bool_switch.html" title="Function bool_switch">bool_switch</a>();
177    <span class="type">BOOST_PROGRAM_OPTIONS_DECL <a href="../typed_value.html" title="Class template typed_value">typed_value</a>&lt; <span class="bold"><strong>bool</strong></span> &gt; *</span> <a href="../bool_switch.html" title="Function bool_switch">bool_switch</a>(<span class="bold"><strong>bool</strong></span> *);
178  }
179}</pre>
180</div>
181<div class="section" lang="en">
182<div class="titlepage"><div><div><h4 class="title">
183<a name="id2524541"></a>Header &lt;<a href="../../../boost/program_options/variables_map.hpp" target="_top">boost/program_options/variables_map.hpp</a>&gt;</h4></div></div></div>
184<pre class="synopsis"><span class="bold"><strong>namespace</strong></span> boost {
185  <span class="bold"><strong>namespace</strong></span> program_options {
186    <span class="bold"><strong>class</strong></span> <a href="../variable_value.html" title="Class variable_value">variable_value</a>;
187    <span class="bold"><strong>class</strong></span> <a href="../abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a>;
188    <span class="bold"><strong>class</strong></span> <a href="../variables_map.html" title="Class variables_map">variables_map</a>;
189    <span class="type">BOOST_PROGRAM_OPTIONS_DECL <span class="bold"><strong>void</strong></span></span> 
190    <a href="../id2349650.html" title="Function store">store</a>(<span class="bold"><strong>const</strong></span> <a href="../basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a>&lt; <span class="bold"><strong>char</strong></span> &gt; &amp;, <a href="../variables_map.html" title="Class variables_map">variables_map</a> &amp;, <span class="bold"><strong>bool</strong></span> = false);
191    <span class="type">BOOST_PROGRAM_OPTIONS_DECL <span class="bold"><strong>void</strong></span></span> 
192    <a href="../id2342502.html" title="Function store">store</a>(<span class="bold"><strong>const</strong></span> <a href="../basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a>&lt; <span class="bold"><strong>wchar_t</strong></span> &gt; &amp;, <a href="../variables_map.html" title="Class variables_map">variables_map</a> &amp;);
193    <span class="type">BOOST_PROGRAM_OPTIONS_DECL <span class="bold"><strong>void</strong></span></span> <a href="../notify.html" title="Function notify">notify</a>(<a href="../variables_map.html" title="Class variables_map">variables_map</a> &amp;);
194  }
195}</pre>
196</div>
197<div class="section" lang="en">
198<div class="titlepage"><div><div><h4 class="title">
199<a name="id2363464"></a>Header &lt;<a href="../../../boost/program_options/version.hpp" target="_top">boost/program_options/version.hpp</a>&gt;</h4></div></div></div>
200<pre class="synopsis">
201
202<a href="../id2363468.html" title="Macro BOOST_PROGRAM_OPTIONS_VERSION">BOOST_PROGRAM_OPTIONS_VERSION</a></pre>
203</div>
204</div>
205<table width="100%"><tr>
206<td align="left"></td>
207<td align="right"><small>Copyright © 2002-2004 Vladimir Prus</small></td>
208</tr></table>
209<hr>
210<div class="spirit-nav">
211<a accesskey="p" href="s06.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../program_options.html"><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="../id2358254.html"><img src="../images/next.png" alt="Next"></a>
212</div>
213</body>
214</html>
Note: See TracBrowser for help on using the repository browser.