_s_d_l__visualtest__process_8h.html (18412B)
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<meta name="generator" content="Doxygen 1.8.4"/> 7<title>SDL Visual Test: C:/Users/DELL/Work/sdlvisualtest/visualtest/include/SDL_visualtest_process.h File Reference</title> 8<link href="tabs.css" rel="stylesheet" type="text/css"/> 9<script type="text/javascript" src="jquery.js"></script> 10<script type="text/javascript" src="dynsections.js"></script> 11<link href="search/search.css" rel="stylesheet" type="text/css"/> 12<script type="text/javascript" src="search/search.js"></script> 13<script type="text/javascript"> 14 $(document).ready(function() { searchBox.OnSelectItem(0); }); 15</script> 16<link href="doxygen.css" rel="stylesheet" type="text/css" /> 17</head> 18<body> 19<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 20<div id="titlearea"> 21<table cellspacing="0" cellpadding="0"> 22 <tbody> 23 <tr style="height: 56px;"> 24 <td style="padding-left: 0.5em;"> 25 <div id="projectname">SDL Visual Test 26 </div> 27 </td> 28 </tr> 29 </tbody> 30</table> 31</div> 32<!-- end header part --> 33<!-- Generated by Doxygen 1.8.4 --> 34<script type="text/javascript"> 35var searchBox = new SearchBox("searchBox", "search",false,'Search'); 36</script> 37 <div id="navrow1" class="tabs"> 38 <ul class="tablist"> 39 <li><a href="index.html"><span>Main Page</span></a></li> 40 <li><a href="annotated.html"><span>Data Structures</span></a></li> 41 <li class="current"><a href="files.html"><span>Files</span></a></li> 42 <li> 43 <div id="MSearchBox" class="MSearchBoxInactive"> 44 <span class="left"> 45 <img id="MSearchSelect" src="search/mag_sel.png" 46 onmouseover="return searchBox.OnSearchSelectShow()" 47 onmouseout="return searchBox.OnSearchSelectHide()" 48 alt=""/> 49 <input type="text" id="MSearchField" value="Search" accesskey="S" 50 onfocus="searchBox.OnSearchFieldFocus(true)" 51 onblur="searchBox.OnSearchFieldFocus(false)" 52 onkeyup="searchBox.OnSearchFieldChange(event)"/> 53 </span><span class="right"> 54 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> 55 </span> 56 </div> 57 </li> 58 </ul> 59 </div> 60 <div id="navrow2" class="tabs2"> 61 <ul class="tablist"> 62 <li><a href="files.html"><span>File List</span></a></li> 63 <li><a href="globals.html"><span>Globals</span></a></li> 64 </ul> 65 </div> 66<!-- window showing the filter options --> 67<div id="MSearchSelectWindow" 68 onmouseover="return searchBox.OnSearchSelectShow()" 69 onmouseout="return searchBox.OnSearchSelectHide()" 70 onkeydown="return searchBox.OnSearchSelectKey(event)"> 71<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> 72 73<!-- iframe showing the search results (closed by default) --> 74<div id="MSearchResultsWindow"> 75<iframe src="javascript:void(0)" frameborder="0" 76 name="MSearchResults" id="MSearchResults"> 77</iframe> 78</div> 79 80<div id="nav-path" class="navpath"> 81 <ul> 82<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul> 83</div> 84</div><!-- top --> 85<div class="header"> 86 <div class="summary"> 87<a href="#nested-classes">Data Structures</a> | 88<a href="#typedef-members">Typedefs</a> | 89<a href="#func-members">Functions</a> </div> 90 <div class="headertitle"> 91<div class="title">SDL_visualtest_process.h File Reference</div> </div> 92</div><!--header--> 93<div class="contents"> 94<div class="textblock"><code>#include <SDL_platform.h></code><br/> 95</div> 96<p><a href="_s_d_l__visualtest__process_8h_source.html">Go to the source code of this file.</a></p> 97<table class="memberdecls"> 98<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> 99Data Structures</h2></td></tr> 100<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a></td></tr> 101<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 102<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a></td></tr> 103<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 104</table><table class="memberdecls"> 105<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> 106Typedefs</h2></td></tr> 107<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> </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__process_8h.html#a94bc9e0b0b563a527ea50ef2eecd5402">SDL_ProcessInfo</a></td></tr> 108<tr class="separator:a94bc9e0b0b563a527ea50ef2eecd5402"><td class="memSeparator" colspan="2"> </td></tr> 109<tr class="memitem:a5b7d5262f85e78bf4d53d88f3c509342"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> 110<a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l__visualtest__process_8h.html#a5b7d5262f85e78bf4d53d88f3c509342">SDL_ProcessExitStatus</a></td></tr> 111<tr class="separator:a5b7d5262f85e78bf4d53d88f3c509342"><td class="memSeparator" colspan="2"> </td></tr> 112</table><table class="memberdecls"> 113<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 114Functions</h2></td></tr> 115<tr class="memitem:a12c16e5b870e2794d6bd5a1a3bb4582f"><td class="memItemLeft" align="right" valign="top">int </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> 116<tr class="separator:a12c16e5b870e2794d6bd5a1a3bb4582f"><td class="memSeparator" colspan="2"> </td></tr> 117<tr class="memitem:a3a131140a71bf68fa68a900f06872239"><td class="memItemLeft" align="right" valign="top">int </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> 118<tr class="separator:a3a131140a71bf68fa68a900f06872239"><td class="memSeparator" colspan="2"> </td></tr> 119<tr class="memitem:ae66242e44a004831ab231693fd11c8d0"><td class="memItemLeft" align="right" valign="top">int </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> 120<tr class="separator:ae66242e44a004831ab231693fd11c8d0"><td class="memSeparator" colspan="2"> </td></tr> 121<tr class="memitem:ad8a5b6725ad1f0e1bac623cf4b6fc28d"><td class="memItemLeft" align="right" valign="top">int </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> 122<tr class="separator:ad8a5b6725ad1f0e1bac623cf4b6fc28d"><td class="memSeparator" colspan="2"> </td></tr> 123<tr class="memitem:a54545d6b9f737a14030b4ce55ddd4a62"><td class="memItemLeft" align="right" valign="top">int </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> 124<tr class="separator:a54545d6b9f737a14030b4ce55ddd4a62"><td class="memSeparator" colspan="2"> </td></tr> 125</table> 126<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 127<div class="textblock"><p>Provides cross-platfrom process launching and termination functionality. </p> 128</div><h2 class="groupheader">Typedef Documentation</h2> 129<a class="anchor" id="a5b7d5262f85e78bf4d53d88f3c509342"></a> 130<div class="memitem"> 131<div class="memproto"> 132 <table class="memname"> 133 <tr> 134 <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> 135 </tr> 136 </table> 137</div><div class="memdoc"> 138<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> 139 140</div> 141</div> 142<a class="anchor" id="a94bc9e0b0b563a527ea50ef2eecd5402"></a> 143<div class="memitem"> 144<div class="memproto"> 145 <table class="memname"> 146 <tr> 147 <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> 148 </tr> 149 </table> 150</div><div class="memdoc"> 151<p>Struct to store a platform specific handle to a process. </p> 152 153</div> 154</div> 155<h2 class="groupheader">Function Documentation</h2> 156<a class="anchor" id="a54545d6b9f737a14030b4ce55ddd4a62"></a> 157<div class="memitem"> 158<div class="memproto"> 159 <table class="memname"> 160 <tr> 161 <td class="memname">int SDL_GetProcessExitStatus </td> 162 <td>(</td> 163 <td class="paramtype"><a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> * </td> 164 <td class="paramname"><em>pinfo</em>, </td> 165 </tr> 166 <tr> 167 <td class="paramkey"></td> 168 <td></td> 169 <td class="paramtype"><a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a> * </td> 170 <td class="paramname"><em>ps</em> </td> 171 </tr> 172 <tr> 173 <td></td> 174 <td>)</td> 175 <td></td><td></td> 176 </tr> 177 </table> 178</div><div class="memdoc"> 179<p>Gets the exit status of a process. If the exit status is -1, the process is still running.</p> 180<dl class="params"><dt>Parameters</dt><dd> 181 <table class="params"> 182 <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> 183 <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> 184 </table> 185 </dd> 186</dl> 187<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> 188 189</div> 190</div> 191<a class="anchor" id="a3a131140a71bf68fa68a900f06872239"></a> 192<div class="memitem"> 193<div class="memproto"> 194 <table class="memname"> 195 <tr> 196 <td class="memname">int SDL_IsProcessRunning </td> 197 <td>(</td> 198 <td class="paramtype"><a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> * </td> 199 <td class="paramname"><em>pinfo</em>)</td><td></td> 200 <td></td> 201 </tr> 202 </table> 203</div><div class="memdoc"> 204<p>Checks if a process is running or not.</p> 205<dl class="params"><dt>Parameters</dt><dd> 206 <table class="params"> 207 <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> 208 </table> 209 </dd> 210</dl> 211<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> 212 213</div> 214</div> 215<a class="anchor" id="ae66242e44a004831ab231693fd11c8d0"></a> 216<div class="memitem"> 217<div class="memproto"> 218 <table class="memname"> 219 <tr> 220 <td class="memname">int SDL_KillProcess </td> 221 <td>(</td> 222 <td class="paramtype"><a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> * </td> 223 <td class="paramname"><em>pinfo</em>, </td> 224 </tr> 225 <tr> 226 <td class="paramkey"></td> 227 <td></td> 228 <td class="paramtype"><a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a> * </td> 229 <td class="paramname"><em>ps</em> </td> 230 </tr> 231 <tr> 232 <td></td> 233 <td>)</td> 234 <td></td><td></td> 235 </tr> 236 </table> 237</div><div class="memdoc"> 238<p>Kills a currently running process.</p> 239<dl class="params"><dt>Parameters</dt><dd> 240 <table class="params"> 241 <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> 242 <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> 243 </table> 244 </dd> 245</dl> 246<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> 247 248</div> 249</div> 250<a class="anchor" id="a12c16e5b870e2794d6bd5a1a3bb4582f"></a> 251<div class="memitem"> 252<div class="memproto"> 253 <table class="memname"> 254 <tr> 255 <td class="memname">int SDL_LaunchProcess </td> 256 <td>(</td> 257 <td class="paramtype">char * </td> 258 <td class="paramname"><em>file</em>, </td> 259 </tr> 260 <tr> 261 <td class="paramkey"></td> 262 <td></td> 263 <td class="paramtype">char * </td> 264 <td class="paramname"><em>args</em>, </td> 265 </tr> 266 <tr> 267 <td class="paramkey"></td> 268 <td></td> 269 <td class="paramtype"><a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> * </td> 270 <td class="paramname"><em>pinfo</em> </td> 271 </tr> 272 <tr> 273 <td></td> 274 <td>)</td> 275 <td></td><td></td> 276 </tr> 277 </table> 278</div><div class="memdoc"> 279<p>Launches a process with the given commandline arguments.</p> 280<dl class="params"><dt>Parameters</dt><dd> 281 <table class="params"> 282 <tr><td class="paramname">file</td><td>The path to the executable to be launched. </td></tr> 283 <tr><td class="paramname">args</td><td>The command line arguments to be passed to the process. </td></tr> 284 <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> 285 </table> 286 </dd> 287</dl> 288<dl class="section return"><dt>Returns</dt><dd>Non-zero on success, zero on failure. </dd></dl> 289 290</div> 291</div> 292<a class="anchor" id="ad8a5b6725ad1f0e1bac623cf4b6fc28d"></a> 293<div class="memitem"> 294<div class="memproto"> 295 <table class="memname"> 296 <tr> 297 <td class="memname">int SDL_QuitProcess </td> 298 <td>(</td> 299 <td class="paramtype"><a class="el" href="struct_s_d_l___process_info.html">SDL_ProcessInfo</a> * </td> 300 <td class="paramname"><em>pinfo</em>, </td> 301 </tr> 302 <tr> 303 <td class="paramkey"></td> 304 <td></td> 305 <td class="paramtype"><a class="el" href="struct_s_d_l___process_exit_status.html">SDL_ProcessExitStatus</a> * </td> 306 <td class="paramname"><em>ps</em> </td> 307 </tr> 308 <tr> 309 <td></td> 310 <td>)</td> 311 <td></td><td></td> 312 </tr> 313 </table> 314</div><div class="memdoc"> 315<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> 316<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> 317 318</div> 319</div> 320</div><!-- contents --> 321<!-- start footer part --> 322<hr class="footer"/><address class="footer"><small> 323Generated on Thu Sep 26 2013 00:18:23 for SDL Visual Test by  <a href="http://www.doxygen.org/index.html"> 324<img class="footer" src="doxygen.png" alt="doxygen"/> 325</a> 1.8.4 326</small></address> 327</body> 328</html>