Mercurial > sdl-ios-xcode

comparison docs/html/sdlsemwaittimeout.html @ 803:355632dca928

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated SDL HTML documentation
author Sam Lantinga <slouken@libsdl.org>
date Tue, 10 Feb 2004 15:15:40 +0000
parents e5bc29de3f0a
children
comparison
equal deleted inserted replaced
802:3c609d54f100 803:355632dca928
2 ><HEAD 2 ><HEAD
3 ><TITLE 3 ><TITLE
4 >SDL_SemWaitTimeout</TITLE 4 >SDL_SemWaitTimeout</TITLE
5 ><META 5 ><META
6 NAME="GENERATOR" 6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8 "><LINK 8 "><LINK
9 REL="HOME" 9 REL="HOME"
10 TITLE="SDL Library Documentation" 10 TITLE="SDL Library Documentation"
11 HREF="index.html"><LINK 11 HREF="index.html"><LINK
12 REL="UP" 12 REL="UP"
26 VLINK="#551a8b" 26 VLINK="#551a8b"
27 ALINK="#ff0000" 27 ALINK="#ff0000"
28 ><DIV 28 ><DIV
29 CLASS="NAVHEADER" 29 CLASS="NAVHEADER"
30 ><TABLE 30 ><TABLE
31 SUMMARY="Header navigation table"
31 WIDTH="100%" 32 WIDTH="100%"
32 BORDER="0" 33 BORDER="0"
33 CELLPADDING="0" 34 CELLPADDING="0"
34 CELLSPACING="0" 35 CELLSPACING="0"
35 ><TR 36 ><TR
43 WIDTH="10%" 44 WIDTH="10%"
44 ALIGN="left" 45 ALIGN="left"
45 VALIGN="bottom" 46 VALIGN="bottom"
46 ><A 47 ><A
47 HREF="sdlsemtrywait.html" 48 HREF="sdlsemtrywait.html"
49 ACCESSKEY="P"
48 >Prev</A 50 >Prev</A
49 ></TD 51 ></TD
50 ><TD 52 ><TD
51 WIDTH="80%" 53 WIDTH="80%"
52 ALIGN="center" 54 ALIGN="center"
56 WIDTH="10%" 58 WIDTH="10%"
57 ALIGN="right" 59 ALIGN="right"
58 VALIGN="bottom" 60 VALIGN="bottom"
59 ><A 61 ><A
60 HREF="sdlsempost.html" 62 HREF="sdlsempost.html"
63 ACCESSKEY="N"
61 >Next</A 64 >Next</A
62 ></TD 65 ></TD
63 ></TR 66 ></TR
64 ></TABLE 67 ></TABLE
65 ><HR 68 ><HR
66 ALIGN="LEFT" 69 ALIGN="LEFT"
67 WIDTH="100%"></DIV 70 WIDTH="100%"></DIV
68 ><H1 71 ><H1
69 ><A 72 ><A
70 NAME="SDLSEMWAITTIMEOUT" 73 NAME="SDLSEMWAITTIMEOUT"
71 >SDL_SemWaitTimeout</A 74 ></A
72 ></H1 75 >SDL_SemWaitTimeout</H1
73 ><DIV 76 ><DIV
74 CLASS="REFNAMEDIV" 77 CLASS="REFNAMEDIV"
75 ><A 78 ><A
76 NAME="AEN7732" 79 NAME="AEN8120"
77 ></A 80 ></A
78 ><H2 81 ><H2
79 >Name</H2 82 >Name</H2
80 >SDL_SemWaitTimeout&nbsp;--&nbsp;Lock a semaphore, but only wait up to a specified maximum time.</DIV 83 >SDL_SemWaitTimeout&nbsp;--&nbsp;Lock a semaphore, but only wait up to a specified maximum time.</DIV
81 ><DIV 84 ><DIV
82 CLASS="REFSYNOPSISDIV" 85 CLASS="REFSYNOPSISDIV"
83 ><A 86 ><A
84 NAME="AEN7735" 87 NAME="AEN8123"
85 ></A 88 ></A
86 ><H2 89 ><H2
87 >Synopsis</H2 90 >Synopsis</H2
88 ><DIV 91 ><DIV
89 CLASS="FUNCSYNOPSIS" 92 CLASS="FUNCSYNOPSIS"
90 ><A 93 ><A
91 NAME="AEN7736" 94 NAME="AEN8124"
92 ></A 95 ></A
93 ><P 96 ><P
94 ></P 97 ></P
95 ><PRE 98 ><PRE
96 CLASS="FUNCSYNOPSISINFO" 99 CLASS="FUNCSYNOPSISINFO"
111 ></DIV 114 ></DIV
112 ></DIV 115 ></DIV
113 ><DIV 116 ><DIV
114 CLASS="REFSECT1" 117 CLASS="REFSECT1"
115 ><A 118 ><A
116 NAME="AEN7742" 119 NAME="AEN8130"
117 ></A 120 ></A
118 ><H2 121 ><H2
119 >Description</H2 122 >Description</H2
120 ><P 123 ><P
121 ><TT 124 ><TT
155 >.</P 158 >.</P
156 ></DIV 159 ></DIV
157 ><DIV 160 ><DIV
158 CLASS="REFSECT1" 161 CLASS="REFSECT1"
159 ><A 162 ><A
160 NAME="AEN7752" 163 NAME="AEN8140"
161 ></A 164 ></A
162 ><H2 165 ><H2
163 >Return Value</H2 166 >Return Value</H2
164 ><P 167 ><P
165 >Returns <SPAN 168 >Returns <SPAN
166 CLASS="RETURNVALUE" 169 CLASS="RETURNVALUE"
167 >0</SPAN 170 >0</SPAN
168 > if the semaphore was successfully locked or 171 > if the semaphore was successfully locked or
169 either <SPAN 172 either <SPAN
170 CLASS="RETURNVALUE" 173 CLASS="RETURNVALUE"
171 >SDL_MUTEX_TIMEOUT</SPAN 174 >SDL_MUTEX_TIMEDOUT</SPAN
172 > or <SPAN 175 > or <SPAN
173 CLASS="RETURNVALUE" 176 CLASS="RETURNVALUE"
174 >-1</SPAN 177 >-1</SPAN
175 > 178 >
176 if the timeout period was exceeded or there was an error, respectivly.</P 179 if the timeout period was exceeded or there was an error, respectivly.</P
178 >If the semaphore was not successfully locked, the semaphore will be unchanged.</P 181 >If the semaphore was not successfully locked, the semaphore will be unchanged.</P
179 ></DIV 182 ></DIV
180 ><DIV 183 ><DIV
181 CLASS="REFSECT1" 184 CLASS="REFSECT1"
182 ><A 185 ><A
183 NAME="AEN7759" 186 NAME="AEN8147"
184 ></A 187 ></A
185 ><H2 188 ><H2
186 >Examples</H2 189 >Examples</H2
187 ><P 190 ><P
188 ><PRE 191 ><PRE
189 CLASS="PROGRAMLISTING" 192 CLASS="PROGRAMLISTING"
190 >res = SDL_SemWaitTimeout(my_sem, WAIT_TIMEOUT_MILLISEC); 193 >res = SDL_SemWaitTimeout(my_sem, WAIT_TIMEOUT_MILLISEC);
191 194
192 if (res == SDL_MUTEX_TIMEOUT) { 195 if (res == SDL_MUTEX_TIMEDOUT) {
193 return TRY_AGAIN; 196 return TRY_AGAIN;
194 } 197 }
195 if (res == -1) { 198 if (res == -1) {
196 return WAIT_ERROR; 199 return WAIT_ERROR;
197 } 200 }
202 ></P 205 ></P
203 ></DIV 206 ></DIV
204 ><DIV 207 ><DIV
205 CLASS="REFSECT1" 208 CLASS="REFSECT1"
206 ><A 209 ><A
207 NAME="AEN7763" 210 NAME="AEN8151"
208 ></A 211 ></A
209 ><H2 212 ><H2
210 >See Also</H2 213 >See Also</H2
211 ><P 214 ><P
212 ><A 215 ><A
255 ><DIV 258 ><DIV
256 CLASS="NAVFOOTER" 259 CLASS="NAVFOOTER"
257 ><HR 260 ><HR
258 ALIGN="LEFT" 261 ALIGN="LEFT"
259 WIDTH="100%"><TABLE 262 WIDTH="100%"><TABLE
263 SUMMARY="Footer navigation table"
260 WIDTH="100%" 264 WIDTH="100%"
261 BORDER="0" 265 BORDER="0"
262 CELLPADDING="0" 266 CELLPADDING="0"
263 CELLSPACING="0" 267 CELLSPACING="0"
264 ><TR 268 ><TR
266 WIDTH="33%" 270 WIDTH="33%"
267 ALIGN="left" 271 ALIGN="left"
268 VALIGN="top" 272 VALIGN="top"
269 ><A 273 ><A
270 HREF="sdlsemtrywait.html" 274 HREF="sdlsemtrywait.html"
275 ACCESSKEY="P"
271 >Prev</A 276 >Prev</A
272 ></TD 277 ></TD
273 ><TD 278 ><TD
274 WIDTH="34%" 279 WIDTH="34%"
275 ALIGN="center" 280 ALIGN="center"
276 VALIGN="top" 281 VALIGN="top"
277 ><A 282 ><A
278 HREF="index.html" 283 HREF="index.html"
284 ACCESSKEY="H"
279 >Home</A 285 >Home</A
280 ></TD 286 ></TD
281 ><TD 287 ><TD
282 WIDTH="33%" 288 WIDTH="33%"
283 ALIGN="right" 289 ALIGN="right"
284 VALIGN="top" 290 VALIGN="top"
285 ><A 291 ><A
286 HREF="sdlsempost.html" 292 HREF="sdlsempost.html"
293 ACCESSKEY="N"
287 >Next</A 294 >Next</A
288 ></TD 295 ></TD
289 ></TR 296 ></TR
290 ><TR 297 ><TR
291 ><TD 298 ><TD
297 WIDTH="34%" 304 WIDTH="34%"
298 ALIGN="center" 305 ALIGN="center"
299 VALIGN="top" 306 VALIGN="top"
300 ><A 307 ><A
301 HREF="thread.html" 308 HREF="thread.html"
309 ACCESSKEY="U"
302 >Up</A 310 >Up</A
303 ></TD 311 ></TD
304 ><TD 312 ><TD
305 WIDTH="33%" 313 WIDTH="33%"
306 ALIGN="right" 314 ALIGN="right"