doc/html/boost/process/basic_native_environment/entry_type.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Struct template entry_type</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="../basic_native_environment.html#id-1.3.31.9.9.4.4" title="Description">
  10 <link rel="prev" href="const_entry_type.html" title="Struct template const_entry_type">
  11 <link rel="next" href="../ignore_error.html" title="Global ignore_error">
  12 </head>
  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>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <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#id-1.3.31.9.9.4.4"><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>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.process.basic_native_environment.entry_type"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Struct template entry_type</span></h2>
  30 <p>boost::process::basic_native_environment::entry_type</p>
  31 </div>
  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: &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;
  34
  35 </span>
  36 <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>
  37 <span class="keyword">struct</span> <a class="link" href="entry_type.html" title="Struct template entry_type">entry_type</a> <span class="special">{</span>
  38   <span class="comment">// types</span>
  39   <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>
  40   <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>
  41   <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>
  42   <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>
  43   <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>
  44
  45   <span class="comment">// <a class="link" href="entry_type.html#boost.process.basic_native_environment.entry_typeconstruct-copy-destruct">construct/copy/destruct</a></span>
  46   <span class="identifier">entry</span> <span class="special">&amp;</span> <a class="link" href="entry_type.html#idm45170605012048-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>
  47   <span class="identifier">entry</span> <span class="special">&amp;</span> <a class="link" href="entry_type.html#idm45170605010224-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>
  48   <span class="identifier">entry</span> <span class="special">&amp;</span> <a class="link" href="entry_type.html#idm45170605008656-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>
  49
  50   <span class="comment">// <a class="link" href="entry_type.html#idm45170605026704-bb">public member functions</a></span>
  51   <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#idm45170605026144-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>
  52    <a class="link" href="entry_type.html#idm45170605024224-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>
  53   <span class="keyword">bool</span> <a class="link" href="entry_type.html#idm45170605022288-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  54   <span class="keyword">void</span> <a class="link" href="entry_type.html#idm45170605020864-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>
  55   <span class="keyword">void</span> <a class="link" href="entry_type.html#idm45170605019024-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>
  56   <span class="keyword">void</span> <a class="link" href="entry_type.html#idm45170605017120-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>
  57   <span class="keyword">void</span> <a class="link" href="entry_type.html#idm45170605015232-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  58   <span class="identifier">entry</span> <span class="special">&amp;</span> <a class="link" href="entry_type.html#idm45170605014096-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>
  59 <span class="special">}</span><span class="special">;</span></pre></div>
  60 <div class="refsect1">
  61 <a name="id-1.3.31.9.9.4.4.6.4"></a><h2>Description</h2>
  62 <p>Proxy class used for read and write access to members by [] or .at() </p>
  63 <div class="note"><table border="0" summary="Note">
  64 <tr>
  65 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
  66 <th align="left">Note</th>
  67 </tr>
  68 <tr><td align="left" valign="top"><p>Holds a reference to the environment it was created from. </p></td></tr>
  69 </table></div>
  70 <p>
  71 </p>
  72 <div class="refsect2">
  73 <a name="id-1.3.31.9.9.4.4.6.4.3"></a><h3>
  74 <a name="boost.process.basic_native_environment.entry_typeconstruct-copy-destruct"></a><code class="computeroutput">entry_type</code>
  75         public
  76        construct/copy/destruct</h3>
  77 <div class="orderedlist"><ol class="orderedlist" type="1">
  78 <li class="listitem">
  79 <pre class="literallayout"><span class="identifier">entry</span> <span class="special">&amp;</span> <a name="idm45170605012048-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>
  80 <li class="listitem">
  81 <pre class="literallayout"><span class="identifier">entry</span> <span class="special">&amp;</span> <a name="idm45170605010224-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>
  82 <li class="listitem">
  83 <pre class="literallayout"><span class="identifier">entry</span> <span class="special">&amp;</span> <a name="idm45170605008656-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 separated by ';' or ':'. </li>
  84 </ol></div>
  85 </div>
  86 <div class="refsect2">
  87 <a name="id-1.3.31.9.9.4.4.6.4.4"></a><h3>
  88 <a name="idm45170605026704-bb"></a><code class="computeroutput">entry_type</code> public member functions</h3>
  89 <div class="orderedlist"><ol class="orderedlist" type="1">
  90 <li class="listitem">
  91 <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="idm45170605026144-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>
  92 </li>
  93 <li class="listitem">
  94 <pre class="literallayout"> <a name="idm45170605024224-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>
  95 <li class="listitem">
  96 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45170605022288-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>
  97 <li class="listitem">
  98 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170605020864-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>
  99 <li class="listitem">
 100 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170605019024-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 separated by ';' or ':'. </li>
 101 <li class="listitem">
 102 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170605017120-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 separated by ';' or ':'. </li>
 103 <li class="listitem">
 104 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45170605015232-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Reset the value. </li>
 105 <li class="listitem">
 106 <pre class="literallayout"><span class="identifier">entry</span> <span class="special">&amp;</span> <a name="idm45170605014096-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 separated by ';' or ':'. </li>
 107 </ol></div>
 108 </div>
 109 </div>
 110 </div>
 111 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 112 <td align="left"></td>
 113 <td align="right"><div class="copyright-footer">Copyright &#169; 2006-2012 Julio M. Merino Vidal, Ilya Sokolov,
 114       Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright &#169; 2016 Klemens D. Morgenstern<p>
 115         Distributed under the Boost Software License, Version 1.0. (See accompanying
 116         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 117       </p>
 118 </div></td>
 119 </tr></table>
 120 <hr>
 121 <div class="spirit-nav">
 122 <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#id-1.3.31.9.9.4.4"><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>
 123 </div>
 124 </body>
 125 </html>