diff options
Diffstat (limited to 'doc/html/id2359751.html')
| -rw-r--r-- | doc/html/id2359751.html | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/html/id2359751.html b/doc/html/id2359751.html new file mode 100644 index 0000000000..d71215dcf6 --- /dev/null +++ b/doc/html/id2359751.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>Function parse_environment</title> +<link rel="stylesheet" href="boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +<link rel="start" href="index.html" title="The Boost C++ Libraries"> +<link rel="up" href="program_options/reference.html#id2442413" title="Header <boost/program_options/parsers.hpp>"> +<link rel="prev" href="collect_unrecognized.html" title="Function template collect_unrecognized"> +<link rel="next" href="id2359806.html" title="Function parse_environment"> +</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="collect_unrecognized.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id2442413"><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="id2359806.html"><img src="images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="id2359751"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function parse_environment</span></h2> +<p>boost::program_options::parse_environment — </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="type">BOOST_PROGRAM_OPTIONS_DECL parsed_options</span> +parse_environment(<span class="bold"><strong>const</strong></span> <a href="options_description.html" title="Class options_description">options_description</a> & , + <span class="bold"><strong>const</strong></span> function1< std::string, std::string > & name_mapper);</pre></div> +<div class="refsect1" lang="en"> +<a name="id2603506"></a><h2>Description</h2> +<p>Parse environment.</p> +<p>For each environment variable, the 'name_mapper' function is called to obtain the option name. If it returns empty string, the variable is ignored.</p> +<p>This is done since naming of environment variables is typically different from the naming of command line options. </p> +</div> +</div> +<table 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="collect_unrecognized.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id2442413"><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="id2359806.html"><img src="images/next.png" alt="Next"></a> +</div> +</body> +</html> |