1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template basic_environment</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../process/reference.html#header.boost.process.environment_hpp" title="Header <boost/process/environment.hpp>">
<link rel="prev" href="env.html" title="Global env">
<link rel="next" href="basic_environment/const_entry_type.html" title="Struct template const_entry_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
<div class="refentry">
<a name="boost.process.basic_environment"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template basic_environment</span></h2>
<p>boost::process::basic_environment — Type definition to hold a seperate 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="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>>
</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">></span>
<span class="keyword">class</span> <a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<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>
<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>
<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>
<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>
<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>
<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>
<span class="comment">// member classes/structs/unions</span>
<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>
<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>
<span class="comment">// types</span>
<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>
<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>
<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>
<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>
<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>
<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>
<span class="identifier">const_entry</span> <span class="special">&</span> <a class="link" href="basic_environment/const_entry_type.html#idp25723984-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>
<span class="comment">// <a class="link" href="basic_environment/const_entry_type.html#idp25718656-bb">public member functions</a></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> <a class="link" href="basic_environment/const_entry_type.html#idp25719152-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>
<a class="link" href="basic_environment/const_entry_type.html#idp25720864-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>
<span class="keyword">bool</span> <a class="link" href="basic_environment/const_entry_type.html#idp25722608-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span>
<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>
<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>
<span class="comment">// types</span>
<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>
<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>
<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>
<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>
<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>
<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>
<span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_environment/entry_type.html#idp25745200-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>
<span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_environment/entry_type.html#idp25746832-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>
<span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_environment/entry_type.html#idp25748224-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>
<span class="comment">// <a class="link" href="basic_environment/entry_type.html#idp25732048-bb">public member functions</a></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> <a class="link" href="basic_environment/entry_type.html#idp25732544-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>
<a class="link" href="basic_environment/entry_type.html#idp25734256-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>
<span class="keyword">bool</span> <a class="link" href="basic_environment/entry_type.html#idp25736000-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="basic_environment/entry_type.html#idp25737248-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>
<span class="keyword">void</span> <a class="link" href="basic_environment/entry_type.html#idp25738880-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>
<span class="keyword">void</span> <a class="link" href="basic_environment/entry_type.html#idp25740608-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>
<span class="keyword">void</span> <a class="link" href="basic_environment/entry_type.html#idp25742336-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">entry</span> <span class="special">&</span> <a class="link" href="basic_environment/entry_type.html#idp25743344-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>
<span class="special">}</span><span class="special">;</span>
<span class="comment">// <a class="link" href="basic_environment.html#boost.process.basic_environmentconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="basic_environment.html#idp25781312-bb"><span class="identifier">basic_environment</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_environment.html#idp25781824-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>
<a class="link" href="basic_environment.html#idp25783344-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>
<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#idp25784736-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>
<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#idp25786768-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>
<span class="comment">// <a class="link" href="basic_environment.html#idp25754480-bb">public member functions</a></span>
<span class="identifier">iterator</span> <a class="link" href="basic_environment.html#idp25754976-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idp25755984-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idp25757232-bb"><span class="identifier">cbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">iterator</span> <a class="link" href="basic_environment.html#idp25758480-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idp25759488-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idp25760736-bb"><span class="identifier">cend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">iterator</span> <a class="link" href="basic_environment.html#idp25761984-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>
<span class="identifier">const_iterator</span> <a class="link" href="basic_environment.html#idp25763616-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>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="basic_environment.html#idp25765488-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>
<span class="keyword">void</span> <a class="link" href="basic_environment.html#idp25767360-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>
<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>
<a class="link" href="basic_environment.html#idp25769120-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>
<span class="keyword">bool</span> <a class="link" href="basic_environment.html#idp25771376-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="basic_environment.html#idp25772384-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="basic_environment.html#idp25773632-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a class="link" href="basic_environment.html#idp25775408-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>
<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#idp25777248-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>
<a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a class="link" href="basic_environment.html#idp25779328-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>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id-1.3.30.9.9.3.4"></a><h2>Description</h2>
<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>
<div class="refsect2">
<a name="id-1.3.30.9.9.3.4.3"></a><h3>
<a name="boost.process.basic_environmentconstruct-copy-destruct"></a><code class="computeroutput">basic_environment</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="idp25781312-bb"></a><span class="identifier">basic_environment</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor. </li>
<li class="listitem">
<pre class="literallayout"><a name="idp25781824-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>
<li class="listitem">
<pre class="literallayout"><a name="idp25783344-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>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span> <a name="idp25784736-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>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_environment.html" title="Class template basic_environment">basic_environment</a> <span class="special">&</span> <a name="idp25786768-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>
</ol></div>
</div>
<div class="refsect2">
<a name="id-1.3.30.9.9.3.4.4"></a><h3>
<a name="idp25754480-bb"></a><code class="computeroutput">basic_environment</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="identifier">iterator</span> <a name="idp25754976-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>
<li class="listitem">
<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp25755984-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>
<li class="listitem">
<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp25757232-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>
<li class="listitem">
<pre class="literallayout"><span class="identifier">iterator</span> <a name="idp25758480-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>
<li class="listitem">
<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp25759488-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>
<li class="listitem">
<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp25760736-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>
<li class="listitem">
<pre class="literallayout"><span class="identifier">iterator</span> <a name="idp25761984-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>
<li class="listitem">
<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp25763616-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>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp25765488-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp25767360-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>
<p>Erase variable by id. </p>
</li>
<li class="listitem">
<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>
<a name="idp25769120-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idp25771376-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>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp25772384-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp25773632-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">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>Use with care, passed environment cannot be empty. </p></td></tr>
</table></div>
<p>
</p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a name="idp25775408-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>
<li class="listitem">
<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="idp25777248-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>
<li class="listitem">
<pre class="literallayout"><a class="link" href="basic_environment/entry_type.html" title="Struct template entry_type">entry_type</a> <a name="idp25779328-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>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov,
Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 2016 Klemens D. Morgenstern<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
</body>
</html>
|
