sdl
/
SDL
mirror of https://github.com/libsdl-org/SDL.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>SDL Visual Test: C:/Users/DELL/Work/sdlvisualtest/visualtest/include/SDL_visualtest_process.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">SDL Visual Test
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">SDL_visualtest_process.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;SDL_platform.h&gt;</code><br/>
</div>
<p><a href="_s_d_l__visualtest__process_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a94bc9e0b0b563a527ea50ef2eecd5402"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__process_8h.html#a94bc9e0b0b563a527ea50ef2eecd5402">SDL_ProcessInfo</a></td></tr>
<tr class="separator:a94bc9e0b0b563a527ea50ef2eecd5402"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b7d5262f85e78bf4d53d88f3c509342"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__process_8h.html#a5b7d5262f85e78bf4d53d88f3c509342">SDL_ProcessExitStatus</a></td></tr>
<tr class="separator:a5b7d5262f85e78bf4d53d88f3c509342"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a12c16e5b870e2794d6bd5a1a3bb4582f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__process_8h.html#a12c16e5b870e2794d6bd5a1a3bb4582f">SDL_LaunchProcess</a> (char *file, char *args, <a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> *pinfo)</td></tr>
<tr class="separator:a12c16e5b870e2794d6bd5a1a3bb4582f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a131140a71bf68fa68a900f06872239"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__process_8h.html#a3a131140a71bf68fa68a900f06872239">SDL_IsProcessRunning</a> (<a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> *pinfo)</td></tr>
<tr class="separator:a3a131140a71bf68fa68a900f06872239"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66242e44a004831ab231693fd11c8d0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__process_8h.html#ae66242e44a004831ab231693fd11c8d0">SDL_KillProcess</a> (<a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> *pinfo, <a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a> *ps)</td></tr>
<tr class="separator:ae66242e44a004831ab231693fd11c8d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8a5b6725ad1f0e1bac623cf4b6fc28d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__process_8h.html#ad8a5b6725ad1f0e1bac623cf4b6fc28d">SDL_QuitProcess</a> (<a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> *pinfo, <a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a> *ps)</td></tr>
<tr class="separator:ad8a5b6725ad1f0e1bac623cf4b6fc28d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54545d6b9f737a14030b4ce55ddd4a62"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__process_8h.html#a54545d6b9f737a14030b4ce55ddd4a62">SDL_GetProcessExitStatus</a> (<a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> *pinfo, <a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a> *ps)</td></tr>
<tr class="separator:a54545d6b9f737a14030b4ce55ddd4a62"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides cross-platfrom process launching and termination functionality. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a5b7d5262f85e78bf4d53d88f3c509342"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a>  <a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This structure stores the exit status (value returned by <a class="el" href="testharness_8c.html#a0ddf1224851353fc92bfbff6f499fa97">main()</a>) and whether the process exited sucessfully or not. </p>

</div>
</div>
<a class="anchor" id="a94bc9e0b0b563a527ea50ef2eecd5402"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a>  <a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Struct to store a platform specific handle to a process. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a54545d6b9f737a14030b4ce55ddd4a62"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int SDL_GetProcessExitStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> *&#160;</td>
          <td class="paramname"><em>pinfo</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a> *&#160;</td>
          <td class="paramname"><em>ps</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Gets the exit status of a process. If the exit status is -1, the process is still running.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pinfo</td><td>Pointer to a <a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> object of the process to be checked. </td></tr>
    <tr><td class="paramname">ps</td><td>Pointer to a <a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a> object which will be populated with the exit status.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl>

</div>
</div>
<a class="anchor" id="a3a131140a71bf68fa68a900f06872239"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int SDL_IsProcessRunning </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> *&#160;</td>
          <td class="paramname"><em>pinfo</em>)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Checks if a process is running or not.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pinfo</td><td>Pointer to <a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> object of the process that needs to be checked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the process is still running; zero if it is not and -1 if the status could not be retrieved. </dd></dl>

</div>
</div>
<a class="anchor" id="ae66242e44a004831ab231693fd11c8d0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int SDL_KillProcess </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> *&#160;</td>
          <td class="paramname"><em>pinfo</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a> *&#160;</td>
          <td class="paramname"><em>ps</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Kills a currently running process.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pinfo</td><td>Pointer to a <a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> object of the process to be terminated. </td></tr>
    <tr><td class="paramname">ps</td><td>Pointer to a <a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a> object which will be populated with the exit status.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl>

</div>
</div>
<a class="anchor" id="a12c16e5b870e2794d6bd5a1a3bb4582f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int SDL_LaunchProcess </td>
          <td>(</td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>file</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>args</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> *&#160;</td>
          <td class="paramname"><em>pinfo</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Launches a process with the given commandline arguments.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">file</td><td>The path to the executable to be launched. </td></tr>
    <tr><td class="paramname">args</td><td>The command line arguments to be passed to the process. </td></tr>
    <tr><td class="paramname">pinfo</td><td>Pointer to an <a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> object to be populated with platform specific information about the launched process.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Non-zero on success, zero on failure. </dd></dl>

</div>
</div>
<a class="anchor" id="ad8a5b6725ad1f0e1bac623cf4b6fc28d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int SDL_QuitProcess </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> *&#160;</td>
          <td class="paramname"><em>pinfo</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a> *&#160;</td>
          <td class="paramname"><em>ps</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Cleanly exits the process represented by <code>pinfo</code> and stores the exit status in the exit status object pointed to by <code>ps</code>.</p>
<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Sep 26 2013 00:18:23 for SDL Visual Test by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>