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=UTF-8"> 5<title>Struct template windows_executor</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.extend_hpp" title="Header <boost/process/extend.hpp>"> 10<link rel="prev" href="require_io_context.html" title="Struct require_io_context"> 11<link rel="next" href="on_setup.html" title="Global on_setup"> 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="require_io_context.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_setup.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.process.extend.windows_executor"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Struct template windows_executor</span></h2> 30<p>boost::process::extend::windows_executor — The windows executor 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: <<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header <boost/process/extend.hpp>">boost/process/extend.hpp</a>> 34 35</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> Sequence<span class="special">></span> 36<span class="keyword">struct</span> <a class="link" href="windows_executor.html" title="Struct template windows_executor">windows_executor</a> <span class="special">{</span> 37 <span class="comment">// types</span> 38 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.process.extend.windows_executor.startup_info_t"></a><span class="identifier">startup_info_t</span><span class="special">;</span> <span class="comment">// The type of the <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms686331.aspx" target="_top">startup-info</a>, depending on the char-type. </span> 39 <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.process.extend.windows_executor.startup_info_ex_t"></a><span class="identifier">startup_info_ex_t</span><span class="special">;</span> <span class="comment">// The type of the <a href="https://msdn.microsoft.com/de-de/library/windows/desktop/ms686329.aspx" target="_top">extended startup-info</a>, depending the char-type; only defined with winapi-version equal or higher than 6. </span> 40 41 <span class="comment">// <a class="link" href="windows_executor.html#idm45243674661760-bb">public member functions</a></span> 42 <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <a class="link" href="windows_executor.html#idm45243674661200-bb"><span class="identifier">error</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 43 <span class="keyword">void</span> <a class="link" href="windows_executor.html#idm45243674659728-bb"><span class="identifier">set_error</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</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">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 44 <span class="keyword">void</span> <a class="link" href="windows_executor.html#idm45243674656160-bb"><span class="identifier">set_error</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> 45 <span class="keyword">void</span> <a class="link" href="windows_executor.html#idm45243674653392-bb"><span class="identifier">set_startup_info_ex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 46 47 <span class="comment">// public data members</span> 48 <span class="identifier">Sequence</span> <span class="special">&</span> <span class="identifier">seq</span><span class="special">;</span> <span class="comment">// A reference to the actual initializer-sequence. </span> 49 <span class="keyword">const</span> <span class="identifier">Char</span> <span class="special">*</span> <span class="identifier">exe</span><span class="special">;</span> <span class="comment">// A pointer to the name of the executable. It's null by default. </span> 50 <span class="keyword">char</span> <span class="identifier">Char</span> <span class="special">*</span> <span class="identifier">cmd_line</span><span class="special">;</span> <span class="comment">// A pointer to the argument-vector. Must be set by some initializer. </span> 51 <span class="keyword">char</span> <span class="identifier">Char</span> <span class="special">*</span> <span class="identifier">env</span><span class="special">;</span> <span class="comment">// A pointer to the environment variables. It's null by default. </span> 52 <span class="keyword">const</span> <span class="identifier">Char</span> <span class="special">*</span> <span class="identifier">work_dir</span><span class="special">;</span> <span class="comment">// A pointer to the working directory. It's null by default. </span> 53 <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">proc_attrs</span><span class="special">;</span> <span class="comment">// A pointer to the process-attributes of type <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa379560.aspx" target="_top">SECURITY_ATTRIBUTES</a>. It's null by default. </span> 54 <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">thread_attrs</span><span class="special">;</span> <span class="comment">// A pointer to the thread-attributes of type <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa379560.aspx" target="_top">SECURITY_ATTRIBUTES</a>. It' null by default. </span> 55 <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">inherit_handles</span><span class="special">;</span> <span class="comment">// A logical bool value setting whether handles shall be inherited or not. </span> 56 <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">proc_info</span><span class="special">;</span> <span class="comment">// The element holding the process-information after process creation. The type is <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms684873.aspx" target="_top">PROCESS_INFORMATION</a></span> 57 <span class="identifier">std</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">atomic</span><span class="special"><</span> <span class="keyword">int</span> <span class="special">></span> <span class="special">></span> <span class="identifier">exit_status</span><span class="special">;</span> <span class="comment">// This shared-pointer holds the exit code. It's done this way, so it can be shared between an <code class="computeroutput">asio::io_context</code> and <a class="link" href="../child.html" title="Class child">child</a>. </span> 58 <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="identifier">creation_flags</span><span class="special">;</span> <span class="comment">// The creation flags of the process. </span> 59 <span class="identifier">startup_info_t</span> <span class="identifier">startup_info</span><span class="special">;</span> <span class="comment">// This element is an instance or a reference (if startup_info_ex exists) to the <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms686331.aspx" target="_top">startup-info</a> for the process. </span> 60 <span class="identifier">startup_info_ex_t</span> <span class="identifier">startup_info_ex</span><span class="special">;</span> <span class="comment">// This element is the instance of the <a href="https://msdn.microsoft.com/de-de/library/windows/desktop/ms686329.aspx" target="_top">extended startup-info</a>. It is only available with a winapi-version equal or highter than 6. </span> 61<span class="special">}</span><span class="special">;</span></pre></div> 62<div class="refsect1"> 63<a name="id-1.3.30.9.13.9.4"></a><h2>Description</h2> 64<p>This type represents the posix executor and can be used for overloading in a custom handler.</p> 65<div class="note"><table border="0" summary="Note"> 66<tr> 67<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> 68<th align="left">Note</th> 69</tr> 70<tr><td align="left" valign="top"><p>It is an alias for the implementation on posix, and a forward-declaration on windows. </p></td></tr> 71</table></div> 72<p> 73 74 75As information for extension development, here is the structure of the process launching (in pseudo-code and uml)</p> 76<pre class="programlisting"> 77<span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> 78 <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45243674793392-bb">on_setup</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">)</span><span class="special">;</span> 79 80<span class="keyword">if</span> <span class="special">(</span><a class="link" href="windows_executor.html#idm45243674661200-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> 81<span class="special">{</span> 82 <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> 83 <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45243674789408-bb">on_error</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">,</span> <a class="link" href="windows_executor.html#idm45243674661200-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 84 <span class="keyword">return</span> <a class="link" href="../child.html" title="Class child">child</a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 85<span class="special">}</span> 86<span class="keyword">int</span> <span class="identifier">err_code</span> <span class="special">=</span> <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms682425.aspx" target="_top"><span class="identifier">CreateProcess</span></a><span class="special">(</span> 87 <span class="identifier">exe</span><span class="special">,</span> 88 <span class="identifier">cmd_line</span><span class="special">,</span> 89 <span class="identifier">proc_attrs</span><span class="special">,</span> 90 <span class="identifier">thread_attrs</span><span class="special">,</span> 91 <span class="identifier">creation_flags</span><span class="special">,</span> 92 <span class="identifier">env</span><span class="special">,</span> 93 <span class="identifier">work_dir</span><span class="special">,</span> 94 <span class="identifier">startup_info</span><span class="special">,</span> 95 <span class="identifier">proc_info</span><span class="special">)</span><span class="special">;</span> 96 97<a class="link" href="../child.html" title="Class child">child</a> <span class="identifier">c</span><span class="special">(</span><span class="identifier">proc_info</span><span class="special">,</span> <span class="identifier">exit_code</span><span class="special">)</span><span class="special">;</span> 98 99<span class="keyword">if</span> <span class="special">(</span><a class="link" href="windows_executor.html#idm45243674661200-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> 100 <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> 101 <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45243674789408-bb">on_error</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">,</span> <a class="link" href="windows_executor.html#idm45243674661200-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 102<span class="keyword">else</span> 103 <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> 104 <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45243674789408-bb">on_success</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">)</span><span class="special">;</span> 105 106<span class="comment">//now we check again, because a on_success handler might've errored.</span> 107<span class="keyword">if</span> <span class="special">(</span><a class="link" href="windows_executor.html#idm45243674661200-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> 108<span class="special">{</span> 109 <span class="keyword">for</span> <span class="special">(</span><span class="keyword">auto</span> <span class="special">&</span> <span class="identifier">s</span> <span class="special">:</span> <span class="identifier">seq</span><span class="special">)</span> 110 <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45243674789408-bb">on_error</a><span class="special">(</span><span class="special">*</span><span class="keyword">this</span><span class="special">,</span> <a class="link" href="windows_executor.html#idm45243674661200-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 111 <span class="keyword">return</span> <a class="link" href="../child.html" title="Class child">child</a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 112<span class="special">}</span> 113<span class="keyword">else</span> 114 <span class="keyword">return</span> <span class="identifier">c</span><span class="special">;</span> 115 116</pre> 117<p> 118</p> 119<div class="mediaobject"> 120<img src="../../../boost_process/windows_exec.svg"><div class="caption"><p>The sequence for windows process creation.</p></div> 121</div> 122<p> 123 </p> 124<div class="refsect2"> 125<a name="id-1.3.30.9.13.9.4.4"></a><h3>Template Parameters</h3> 126<div class="orderedlist"><ol class="orderedlist" type="1"> 127<li class="listitem"> 128<pre class="literallayout"><span class="keyword">typename</span> Char</pre> 129<p>The used char-type, either <code class="computeroutput">char</code> or <code class="computeroutput">wchar_t</code>.</p> 130</li> 131<li class="listitem"> 132<pre class="literallayout"><span class="keyword">typename</span> Sequence</pre> 133<p>The used initializer-sequence, it is fulfills the boost.fusion <a href="http://www.boost.org/doc/libs/master/libs/fusion/doc/html/fusion/sequence.html" target="_top">sequence</a> concept. </p> 134</li> 135</ol></div> 136</div> 137<div class="refsect2"> 138<a name="id-1.3.30.9.13.9.4.5"></a><h3> 139<a name="idm45243674661760-bb"></a><code class="computeroutput">windows_executor</code> public member functions</h3> 140<div class="orderedlist"><ol class="orderedlist" type="1"> 141<li class="listitem"> 142<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <a name="idm45243674661200-bb"></a><span class="identifier">error</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>This function returns a const reference to the error state of the executor. </li> 143<li class="listitem"> 144<pre class="literallayout"><span class="keyword">void</span> <a name="idm45243674659728-bb"></a><span class="identifier">set_error</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> msg<span class="special">)</span><span class="special">;</span></pre> 145<p>This function can be used to report an error to the executor. This will be handled according to the configuration of the executor, i.e. it might throw an exception. </p> 146<div class="note"><table border="0" summary="Note"> 147<tr> 148<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> 149<th align="left">Note</th> 150</tr> 151<tr><td align="left" valign="top"><p>This is the required way to handle errors in initializers. </p></td></tr> 152</table></div> 153<p> 154</p> 155</li> 156<li class="listitem"> 157<pre class="literallayout"><span class="keyword">void</span> <a name="idm45243674656160-bb"></a><span class="identifier">set_error</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> ec<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> msg<span class="special">)</span><span class="special">;</span></pre> 158<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> 159</li> 160<li class="listitem"> 161<pre class="literallayout"><span class="keyword">void</span> <a name="idm45243674653392-bb"></a><span class="identifier">set_startup_info_ex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>This function switches the information, so that the extended structure is used. <div class="note"><table border="0" summary="Note"> 162<tr> 163<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> 164<th align="left">Note</th> 165</tr> 166<tr><td align="left" valign="top"><p>It's only defined with winapi-version equal or higher than 6. </p></td></tr> 167</table></div> 168<p> 169</p> 170</li> 171</ol></div> 172</div> 173</div> 174</div> 175<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 176<td align="left"></td> 177<td align="right"><div class="copyright-footer">Copyright © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, 178 Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 2016 Klemens D. Morgenstern<p> 179 Distributed under the Boost Software License, Version 1.0. (See accompanying 180 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 181 </p> 182</div></td> 183</tr></table> 184<hr> 185<div class="spirit-nav"> 186<a accesskey="p" href="require_io_context.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_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="on_setup.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 187</div> 188</body> 189</html> 190
