| 1 | <html> |
|---|
| 2 | <head> |
|---|
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
|---|
| 4 | <title>Function parse_environment</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#id730253" title="Header <boost/program_options/parsers.hpp>"> |
|---|
| 9 | <link rel="prev" href="parse_config_file.html" title="Function template parse_config_file"> |
|---|
| 10 | <link rel="next" href="id1045724.html" title="Function parse_environment"> |
|---|
| 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="parse_config_file.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id730253"><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="id1045724.html"><img src="images/next.png" alt="Next"></a> |
|---|
| 24 | </div> |
|---|
| 25 | <div class="refentry" lang="en"> |
|---|
| 26 | <a name="id1010247"></a><div class="titlepage"></div> |
|---|
| 27 | <div class="refnamediv"> |
|---|
| 28 | <h2><span class="refentrytitle">Function parse_environment</span></h2> |
|---|
| 29 | <p>boost::program_options::parse_environment — </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"> |
|---|
| 33 | <span class="type">BOOST_PROGRAM_OPTIONS_DECL parsed_options</span> |
|---|
| 34 | parse_environment(<span class="bold"><strong>const</strong></span> <a href="options_description.html" title="Class options_description">options_description</a> & , |
|---|
| 35 | <span class="bold"><strong>const</strong></span> function1< std::string, std::string > & name_mapper);</pre></div> |
|---|
| 36 | <div class="refsect1" lang="en"> |
|---|
| 37 | <a name="id1255845"></a><h2>Description</h2> |
|---|
| 38 | <p>Parse environment.</p> |
|---|
| 39 | <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> |
|---|
| 40 | <p>This is done since naming of environment variables is typically different from the naming of command line options. </p> |
|---|
| 41 | </div> |
|---|
| 42 | </div> |
|---|
| 43 | <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
|---|
| 44 | <td align="left"></td> |
|---|
| 45 | <td align="right"><small>Copyright © 2002-2004 Vladimir Prus</small></td> |
|---|
| 46 | </tr></table> |
|---|
| 47 | <hr> |
|---|
| 48 | <div class="spirit-nav"> |
|---|
| 49 | <a accesskey="p" href="parse_config_file.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id730253"><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="id1045724.html"><img src="images/next.png" alt="Next"></a> |
|---|
| 50 | </div> |
|---|
| 51 | </body> |
|---|
| 52 | </html> |
|---|
