summaryrefslogtreecommitdiff
path: root/doc/html/boost/process/basic_native_environment/entry_type.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost/process/basic_native_environment/entry_type.html')
-rw-r--r--doc/html/boost/process/basic_native_environment/entry_type.html125
1 files changed, 125 insertions, 0 deletions
diff --git a/doc/html/boost/process/basic_native_environment/entry_type.html b/doc/html/boost/process/basic_native_environment/entry_type.html
new file mode 100644
index 0000000000..573e9f4e5c
--- /dev/null
+++ b/doc/html/boost/process/basic_native_environment/entry_type.html
@@ -0,0 +1,125 @@
+<!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>Struct template entry_type</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="../basic_native_environment.html#idp434414016" title="Description">
+<link rel="prev" href="const_entry_type.html" title="Struct template const_entry_type">
+<link rel="next" href="../ignore_error.html" title="Global ignore_error">
+</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="const_entry_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_native_environment.html#idp434414016"><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="../ignore_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="refentry">
+<a name="boost.process.basic_native_environment.entry_type"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2><span class="refentrytitle">Struct template entry_type</span></h2>
+<p>boost::process::basic_native_environment::entry_type</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: &lt;<a class="link" href="../../../process/reference.html#header.boost.process.environment_hpp" title="Header &lt;boost/process/environment.hpp&gt;">boost/process/environment.hpp</a>&gt;
+
+</span>
+<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Char<span class="special">,</span> <span class="keyword">typename</span> Environment<span class="special">&gt;</span>
+<span class="keyword">struct</span> <a class="link" href="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 name="boost.process.basic_native_environment.entry_type.value_type"></a><span class="identifier">value_type</span><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 name="boost.process.basic_native_environment.entry_type.pointer"></a><span class="identifier">pointer</span><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">&lt;</span> <span class="identifier">value_type</span> <span class="special">&gt;</span> <a name="boost.process.basic_native_environment.entry_type.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">iterator_range</span><span class="special">&lt;</span> <span class="identifier">pointer</span> <span class="special">&gt;</span> <a name="boost.process.basic_native_environment.entry_type.range"></a><span class="identifier">range</span><span class="special">;</span>
+ <span class="keyword">typedef</span> <span class="identifier">Environment</span> <a name="boost.process.basic_native_environment.entry_type.environment_t"></a><span class="identifier">environment_t</span><span class="special">;</span>
+
+ <span class="comment">// <a class="link" href="entry_type.html#boost.process.basic_native_environment.entry_typeconstruct-copy-destruct">construct/copy/destruct</a></span>
+ <span class="identifier">entry</span> <span class="special">&amp;</span> <a class="link" href="entry_type.html#idp38355600-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">&amp;</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">&amp;</span> <a class="link" href="entry_type.html#idp38357424-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">&amp;</span><span class="special">)</span><span class="special">;</span>
+ <span class="identifier">entry</span> <span class="special">&amp;</span> <a class="link" href="entry_type.html#idp38358992-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">&lt;</span> <span class="identifier">string_type</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+
+ <span class="comment">// <a class="link" href="entry_type.html#idp38340944-bb">public member functions</a></span>
+ <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">string_type</span> <span class="special">&gt;</span> <a class="link" href="entry_type.html#idp38341504-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="entry_type.html#idp38343424-bb"><span class="identifier">entry</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&amp;</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="entry_type.html#idp38345360-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="entry_type.html#idp38346784-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">&amp;</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">void</span> <a class="link" href="entry_type.html#idp38348624-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">&lt;</span> <span class="identifier">string_type</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">void</span> <a class="link" href="entry_type.html#idp38350528-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">&amp;</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">void</span> <a class="link" href="entry_type.html#idp38352416-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">&amp;</span> <a class="link" href="entry_type.html#idp38353552-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">&amp;</span><span class="special">)</span><span class="special">;</span>
+<span class="special">}</span><span class="special">;</span></pre></div>
+<div class="refsect1">
+<a name="idp434748512"></a><h2>Description</h2>
+<p>Proxy class used for read and write access to members by [] or .at() </p>
+<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>Holds a reference to the environment it was created from. </p></td></tr>
+</table></div>
+<p>
+</p>
+<div class="refsect2">
+<a name="idp434749776"></a><h3>
+<a name="boost.process.basic_native_environment.entry_typeconstruct-copy-destruct"></a><code class="computeroutput">entry_type</code>
+ public
+ construct/copy/destruct</h3>
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">
+<pre class="literallayout"><span class="identifier">entry</span> <span class="special">&amp;</span> <a name="idp38355600-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Move Constructor. </li>
+<li class="listitem">
+<pre class="literallayout"><span class="identifier">entry</span> <span class="special">&amp;</span> <a name="idp38357424-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>Assign a string to the entry. </li>
+<li class="listitem">
+<pre class="literallayout"><span class="identifier">entry</span> <span class="special">&amp;</span> <a name="idp38358992-bb"></a><span class="keyword">operator</span><span class="special">=</span><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">&lt;</span> <span class="identifier">string_type</span> <span class="special">&gt;</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>Assign a set of strings to the entry; they will be seperated by ';' or ':'. </li>
+</ol></div>
+</div>
+<div class="refsect2">
+<a name="idp434779488"></a><h3>
+<a name="idp38340944-bb"></a><code class="computeroutput">entry_type</code> public member functions</h3>
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">
+<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">string_type</span> <span class="special">&gt;</span> <a name="idp38341504-bb"></a><span class="identifier">to_vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Split the entry by ";" or ":" and return it as a vector. Used by PATH. <p>Get the value as string. Get the name of this entry. </p>
+</li>
+<li class="listitem">
+<pre class="literallayout"> <a name="idp38343424-bb"></a><span class="identifier">entry</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">entry</span> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Copy Constructor. </li>
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">bool</span> <a name="idp38345360-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Check if the entry is empty. </li>
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp38346784-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>Assign a string to the value. </li>
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp38348624-bb"></a><span class="identifier">assign</span><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">&lt;</span> <span class="identifier">string_type</span> <span class="special">&gt;</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>Assign a set of strings to the entry; they will be seperated by ';' or ':'. </li>
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp38350528-bb"></a><span class="identifier">append</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>Append a string to the end of the entry, it will seperated by ';' or ':'. </li>
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp38352416-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Reset the value. </li>
+<li class="listitem">
+<pre class="literallayout"><span class="identifier">entry</span> <span class="special">&amp;</span> <a name="idp38353552-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> value<span class="special">)</span><span class="special">;</span></pre>Append a string to the end of the entry, it will seperated by ';' or ':'. </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 &#169; 2006-2012 Julio M. Merino Vidal, Ilya Sokolov,
+ Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright &#169; 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="const_entry_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_native_environment.html#idp434414016"><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="../ignore_error.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>