1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5 <title>Class template basic_environment</title>
6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9 <link rel="up" href="../../process/reference.html#header.boost.process.environment_hpp" title="Header <boost/process/environment.hpp>">
10 <link rel="prev" href="env.html" title="Global env">
11 <link rel="next" href="basic_environment/const_entry_type.html" title="Struct template const_entry_type">
13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14 <table cellpadding="2" width="100%"><tr>
15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
16 <td align="center"><a href="../../../../index.html">Home</a></td>
17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
23 <div class="spirit-nav">
24 <a accesskey="p" href="env.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.environment_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_environment/const_entry_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="refentry">
27 <a name="boost.process.basic_environment"></a><div class="titlepage"></div>
28 <div class="refnamediv">
29 <h2><span class="refentrytitle">Class template basic_environment</span></h2>
30 <p>boost::process::basic_environment — Type definition to hold a seperate environment. </p>
32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../process/reference.html#header.boost.process.environment_hpp" title="Header <boost/process/environment.hpp>">boost/process/environment.hpp</a>>
35 </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">></span>
36 <span class="keyword">class</span> <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">{</span>
37 <span class="keyword">public</span><span class="special">:</span>
38 <span class="comment">// types</span>
39 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">Char</span> <span class="special">></span> <a name="boost.process.basic_environment.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>
40 <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">transform_iterator</span><span class="special"><</span> <span class="identifier">entry_maker</span><span class="special">,</span> <span class="identifier">Char</span> <span class="special">*</span><span class="special">*</span> <span class="special">></span> <a name="boost.process.basic_environment.iterator"></a><span class="identifier">iterator</span><span class="special">;</span>
41 <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">transform_iterator</span><span class="special"><</span> <span class="identifier">const_entry_maker</span><span class="special">,</span> <span class="identifier">Char</span> <span class="special">*</span><span class="special">*</span> <span class="special">></span> <a name="boost.process.basic_environment.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span>
42 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="boost.process.basic_environment.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>
43 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.process.basic_environment.native_handle"></a><span class="identifier">native_handle</span><span class="special">;</span>
44 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.process.basic_environment.base_type"></a><span class="identifier">base_type</span><span class="special">;</span>
46 <span class="comment">// member classes/structs/unions</span>
47 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">,</span> <span class="keyword">typename</span> Environment<span class="special">></span>
48 <span class="keyword">struct</span> <a class="link" href="basic_environment/const_entry_type.html" title="Struct template const_entry_type">const_entry_type</a> <span class="special">{</span>
49 <span class="comment">// types</span>
50 <span class="keyword">typedef</span> <span class="identifier">Char</span> <a class="link" href="basic_environment/const_entry_type.html#boost.process.basic_environment.const_entry_type.value_type"><span class="identifier">value_type</span></a><span class="special">;</span>
51 <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">*</span> <a class="link" href="basic_environment/const_entry_type.html#boost.process.basic_environment.const_entry_type.pointer"><span class="identifier">pointer</span></a><span class="special">;</span>
52 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span> <a class="link" href="basic_environment/const_entry_type.html#boost.process.basic_environment.const_entry_type.string_type"><span class="identifier">string_type</span></a><span class="special">;</span>
53 <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">pointer</span> <span class="special">></span> <a class="link" href="basic_environment/const_entry_type.html#boost.process.basic_environment.const_entry_type.range"><span class="identifier">range</span></a><span class="special">;</span>
54 <span class="keyword">typedef</span> <span class="identifier">Environment</span> <a class="link" href="basic_environment/const_entry_type.html#boost.process.basic_environment.const_entry_type.environment_t"><span class="identifier">environment_t</span></a><span class="special">;</span>
56 <span class="comment">// <a class="link" href="basic_environment/const_entry_type.html#boost.process.basic_environment.const_entry_typeconstruct-copy-destruct">construct/copy/destruct</a></span>
57 <span class="identifier">const_entry</span> <span class="special">&</span> <a class="link" href="basic_environment/const_entry_type.html#idm45170605118192-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
59 <span class="comment">// <a class="link" href="basic_environment/const_entry_type.html#idm45170605123520-bb">public member functions</a></span>
60 <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a class="link" href="basic_environment/const_entry_type.html#idm45170605123024-bb"><span class="identifier">to_vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
61 <a class="link" href="basic_environment/const_entry_type.html#idm45170605121312-bb"><span class="identifier">const_entry</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">const_entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
62 <span class="keyword">bool</span> <a class="link" href="basic_environment/const_entry_type.html#idm45170605119568-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
63 <span class="special">}</span><span class="special">;</span>
64 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">,</span> <span class="keyword">typename</span> Environment<span class="special">></span>
65 <span class="keyword">struct</span> <a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <span class="special">{</span>
66 <span class="comment">// types</span>
67 <span class="keyword">typedef</span> <span class="identifier">Char</span> <a class="link" href="basic_environment/entry_type.html#boost.process.basic_environment.entry_type.value_type"><span class="identifier">value_type</span></a><span class="special">;</span>
68 <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">*</span> <a class="link" href="basic_environment/entry_type.html#boost.process.basic_environment.entry_type.pointer"><span class="identifier">pointer</span></a><span class="special">;</span>
69 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">value_type</span> <span class="special">></span> <a class="link" href="basic_environment/entry_type.html#boost.process.basic_environment.entry_type.string_type"><span class="identifier">string_type</span></a><span class="special">;</span>
70 <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span><span class="special"><</span> <span class="identifier">pointer</span> <span class="special">></span> <a class="link" href="basic_environment/entry_type.html#boost.process.basic_environment.entry_type.range"><span class="identifier">range</span></a><span class="special">;</span>
71 <span class="keyword">typedef</span> <span class="identifier">Environment</span> <a class="link" href="basic_environment/entry_type.html#boost.process.basic_environment.entry_type.environment_t"><span class="identifier">environment_t</span></a><span class="special">;</span>
73 <span class="comment">// <a class="link" href="basic_environment/entry_type.html#boost.process.basic_environment.entry_typeconstruct-copy-destruct">construct/copy/destruct</a></span>
74 <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_environment/entry_type.html#idm45170605096848-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
75 <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_environment/entry_type.html#idm45170605095216-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
76 <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_environment/entry_type.html#idm45170605093824-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
78 <span class="comment">// <a class="link" href="basic_environment/entry_type.html#idm45170605110000-bb">public member functions</a></span>
79 <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a class="link" href="basic_environment/entry_type.html#idm45170605109504-bb"><span class="identifier">to_vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
80 <a class="link" href="basic_environment/entry_type.html#idm45170605107792-bb"><span class="identifier">entry</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
81 <span class="keyword">bool</span> <a class="link" href="basic_environment/entry_type.html#idm45170605106048-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
82 <span class="keyword">void</span> <a class="link" href="basic_environment/entry_type.html#idm45170605104800-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
83 <span class="keyword">void</span> <a class="link" href="basic_environment/entry_type.html#idm45170605103168-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
84 <span class="keyword">void</span> <a class="link" href="basic_environment/entry_type.html#idm45170605101440-bb"><span class="identifier">append</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
85 <span class="keyword">void</span> <a class="link" href="basic_environment/entry_type.html#idm45170605099712-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
86 <span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_environment/entry_type.html#idm45170605098704-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
87 <span class="special">}</span><span class="special">;</span>
89 <span class="comment">// <a class="link" href="basic_environment.html#boost.process.basic_environmentconstruct-copy-destruct">construct/copy/destruct</a></span>
90 <a class="link" href="basic_environment.html#idm45170605059664-bb"><span class="identifier">basic_environment</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
91 <a class="link" href="basic_environment.html#idm45170605059088-bb"><span class="identifier">basic_environment</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
92 <a class="link" href="basic_environment.html#idm45170605057376-bb"><span class="identifier">basic_environment</span></a><span class="special">(</span><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span>
93 <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span> <a class="link" href="basic_environment.html#idm45170605055824-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
94 <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span> <a class="link" href="basic_environment.html#idm45170605053536-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span>
96 <span class="comment">// <a class="link" href="basic_environment.html#idm45170605087568-bb">public member functions</a></span>
97 <span class="identifier">iterator</span> <a class="link" href="basic_environment.html#idm45170605087072-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
98 <span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idm45170605086064-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
99 <span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idm45170605084816-bb"><span class="identifier">cbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
100 <span class="identifier">iterator</span> <a class="link" href="basic_environment.html#idm45170605083568-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
101 <span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idm45170605082560-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
102 <span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idm45170605081312-bb"><span class="identifier">cend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
103 <span class="identifier">iterator</span> <a class="link" href="basic_environment.html#idm45170605080064-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
104 <span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idm45170605078432-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
105 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="basic_environment.html#idm45170605076560-bb"><span class="identifier">count</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
106 <span class="keyword">void</span> <a class="link" href="basic_environment.html#idm45170605074688-bb"><span class="identifier">erase</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
107 <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">></span>
108 <a class="link" href="basic_environment.html#idm45170605072928-bb"><span class="identifier">emplace</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
109 <span class="keyword">bool</span> <a class="link" href="basic_environment.html#idm45170605070672-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
110 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="basic_environment.html#idm45170605069664-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
111 <span class="keyword">void</span> <a class="link" href="basic_environment.html#idm45170605068272-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
112 <a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a class="link" href="basic_environment.html#idm45170605066112-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
113 <a class="link" href="basic_environment/const_entry_type.html" title="Struct template const_entry_type">const_entry_type</a> <a class="link" href="basic_environment.html#idm45170605064112-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
114 <a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a class="link" href="basic_environment.html#idm45170605061840-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
115 <span class="special">}</span><span class="special">;</span></pre></div>
116 <div class="refsect1">
117 <a name="id-1.3.31.9.9.3.4"></a><h2>Description</h2>
118 <p>Template representation of environments. It takes a character type (<code class="computeroutput">char</code> or <code class="computeroutput">wchar_t</code>) as template parameter to implement the environment </p>
119 <div class="refsect2">
120 <a name="id-1.3.31.9.9.3.4.3"></a><h3>
121 <a name="boost.process.basic_environmentconstruct-copy-destruct"></a><code class="computeroutput">basic_environment</code>
123 construct/copy/destruct</h3>
124 <div class="orderedlist"><ol class="orderedlist" type="1">
125 <li class="listitem">
126 <pre class="literallayout"><a name="idm45170605059664-bb"></a><span class="identifier">basic_environment</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor. </li>
127 <li class="listitem">
128 <pre class="literallayout"><a name="idm45170605059088-bb"></a><span class="identifier">basic_environment</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre>Copy constructor. </li>
129 <li class="listitem">
130 <pre class="literallayout"><a name="idm45170605057376-bb"></a><span class="identifier">basic_environment</span><span class="special">(</span><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span></pre>Move constructor. </li>
131 <li class="listitem">
132 <pre class="literallayout"><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span> <a name="idm45170605055824-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre>Copy assignment. </li>
133 <li class="listitem">
134 <pre class="literallayout"><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span> <a name="idm45170605053536-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span></pre>Move assignment. </li>
137 <div class="refsect2">
138 <a name="id-1.3.31.9.9.3.4.4"></a><h3>
139 <a name="idm45170605087568-bb"></a><code class="computeroutput">basic_environment</code> public member functions</h3>
140 <div class="orderedlist"><ol class="orderedlist" type="1">
141 <li class="listitem">
142 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idm45170605087072-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns an iterator to the beginning. </li>
143 <li class="listitem">
144 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm45170605086064-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the beginning. </li>
145 <li class="listitem">
146 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm45170605084816-bb"></a><span class="identifier">cbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the beginning. </li>
147 <li class="listitem">
148 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idm45170605083568-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns an iterator to the end. </li>
149 <li class="listitem">
150 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm45170605082560-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the end. </li>
151 <li class="listitem">
152 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm45170605081312-bb"></a><span class="identifier">cend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns an iterator to the end. </li>
153 <li class="listitem">
154 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idm45170605080064-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre>Find a variable by its name. </li>
155 <li class="listitem">
156 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm45170605078432-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Find a variable by its name. </li>
157 <li class="listitem">
158 <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idm45170605076560-bb"></a><span class="identifier">count</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> st<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Number of variables. </li>
159 <li class="listitem">
160 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170605074688-bb"></a><span class="identifier">erase</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> id<span class="special">)</span><span class="special">;</span></pre>
161 <p>Erase variable by id. </p>
163 <li class="listitem">
164 <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">></span>
165 <a name="idm45170605072928-bb"></a><span class="identifier">emplace</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> id<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>Emplace an environment variable. </li>
166 <li class="listitem">
167 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45170605070672-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Check if environment has entries. </li>
168 <li class="listitem">
169 <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idm45170605069664-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get the number of variables. </li>
170 <li class="listitem">
171 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170605068272-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Clear the environment. <div class="note"><table border="0" summary="Note">
173 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
174 <th align="left">Note</th>
176 <tr><td align="left" valign="top"><p>Use with care, passed environment cannot be empty. </p></td></tr>
181 <li class="listitem">
182 <pre class="literallayout"><a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a name="idm45170605066112-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre>Get the entry with the key. Throws if it does not exist. </li>
183 <li class="listitem">
184 <pre class="literallayout"><a class="link" href="basic_environment/const_entry_type.html" title="Struct template const_entry_type">const_entry_type</a> <a name="idm45170605064112-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Get the entry with the key. Throws if it does not exist. </li>
185 <li class="listitem">
186 <pre class="literallayout"><a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a name="idm45170605061840-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre>Get the entry with the given key. It creates the entry if it doesn't exist. </li>
191 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
192 <td align="left"></td>
193 <td align="right"><div class="copyright-footer">Copyright © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov,
194 Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 2016 Klemens D. Morgenstern<p>
195 Distributed under the Boost Software License, Version 1.0. (See accompanying
196 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
201 <div class="spirit-nav">
202 <a accesskey="p" href="env.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.environment_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_environment/const_entry_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>