diff options
Diffstat (limited to 'doc/html/boost/process/extend/windows_executor.html')
-rw-r--r-- | doc/html/boost/process/extend/windows_executor.html | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/doc/html/boost/process/extend/windows_executor.html b/doc/html/boost/process/extend/windows_executor.html index 36e46a2887..3eea08fc23 100644 --- a/doc/html/boost/process/extend/windows_executor.html +++ b/doc/html/boost/process/extend/windows_executor.html @@ -38,11 +38,11 @@ <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> <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> - <span class="comment">// <a class="link" href="windows_executor.html#idm45820239828560-bb">public member functions</a></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> <a class="link" href="windows_executor.html#idm45820239828000-bb"><span class="identifier">error</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="windows_executor.html#idm45820239826528-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> - <span class="keyword">void</span> <a class="link" href="windows_executor.html#idm45820239822960-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> - <span class="keyword">void</span> <a class="link" href="windows_executor.html#idm45820239820192-bb"><span class="identifier">set_startup_info_ex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="windows_executor.html#idm45512231697568-bb">public member functions</a></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> <a class="link" href="windows_executor.html#idm45512231697008-bb"><span class="identifier">error</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="windows_executor.html#idm45512231695536-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> + <span class="keyword">void</span> <a class="link" href="windows_executor.html#idm45512231691968-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> + <span class="keyword">void</span> <a class="link" href="windows_executor.html#idm45512231689200-bb"><span class="identifier">set_startup_info_ex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="comment">// public data members</span> <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> @@ -75,12 +75,12 @@ As information for extension development, here is the structure of the process launching (in pseudo-code and uml)</p> <pre class="programlisting"> <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> - <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45820239960192-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> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45512231829200-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> -<span class="keyword">if</span> <span class="special">(</span><a class="link" href="windows_executor.html#idm45820239828000-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> +<span class="keyword">if</span> <span class="special">(</span><a class="link" href="windows_executor.html#idm45512231697008-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> <span class="special">{</span> <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> - <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45820239956208-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#idm45820239828000-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45512231825216-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#idm45512231697008-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> <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> <span class="special">}</span> <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> @@ -96,18 +96,18 @@ As information for extension development, here is the structure of the process l <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> -<span class="keyword">if</span> <span class="special">(</span><a class="link" href="windows_executor.html#idm45820239828000-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> +<span class="keyword">if</span> <span class="special">(</span><a class="link" href="windows_executor.html#idm45512231697008-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> <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> - <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45820239956208-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#idm45820239828000-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45512231825216-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#idm45512231697008-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> <span class="keyword">else</span> <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> - <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45820239956208-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> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45512231825216-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> <span class="comment">//now we check again, because a on_success handler might've errored.</span> -<span class="keyword">if</span> <span class="special">(</span><a class="link" href="windows_executor.html#idm45820239828000-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> +<span class="keyword">if</span> <span class="special">(</span><a class="link" href="windows_executor.html#idm45512231697008-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span> <span class="special">{</span> <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> - <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45820239956208-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#idm45820239828000-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">s</span><span class="special">.</span><a class="link" href="handler.html#idm45512231825216-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#idm45512231697008-bb">error</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> <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> <span class="special">}</span> <span class="keyword">else</span> @@ -136,12 +136,12 @@ As information for extension development, here is the structure of the process l </div> <div class="refsect2"> <a name="id-1.3.31.9.13.9.4.5"></a><h3> -<a name="idm45820239828560-bb"></a><code class="computeroutput">windows_executor</code> public member functions</h3> +<a name="idm45512231697568-bb"></a><code class="computeroutput">windows_executor</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<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="idm45820239828000-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> +<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="idm45512231697008-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> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idm45820239826528-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idm45512231695536-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> <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> <div class="note"><table border="0" summary="Note"> <tr> @@ -154,11 +154,11 @@ As information for extension development, here is the structure of the process l </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idm45820239822960-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idm45512231691968-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> <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idm45820239820192-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"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idm45512231689200-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"> <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> |