/
_s_d_l__visualtest__process_8h.html
executable file
·328 lines (319 loc) · 18 KB
/
_s_d_l__visualtest__process_8h.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
<!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 Page</span></a></li>
<li><a href="annotated.html"><span>Data 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 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"> </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>
<!-- 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> |
<a href="#typedef-members">Typedefs</a> |
<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 <SDL_platform.h></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  </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"> </td></tr>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2"> </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> </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"> </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> </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"> </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 </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"> </td></tr>
<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>
<tr class="separator:a3a131140a71bf68fa68a900f06872239"><td class="memSeparator" colspan="2"> </td></tr>
<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>
<tr class="separator:ae66242e44a004831ab231693fd11c8d0"><td class="memSeparator" colspan="2"> </td></tr>
<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>
<tr class="separator:ad8a5b6725ad1f0e1bac623cf4b6fc28d"><td class="memSeparator" colspan="2"> </td></tr>
<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>
<tr class="separator:a54545d6b9f737a14030b4ce55ddd4a62"><td class="memSeparator" colspan="2"> </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> * </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> * </td>
<td class="paramname"><em>ps</em> </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> * </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> * </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> * </td>
<td class="paramname"><em>ps</em> </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 * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </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> * </td>
<td class="paramname"><em>pinfo</em> </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> * </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> * </td>
<td class="paramname"><em>ps</em> </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  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>