• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_CondWaitTimeout</TITLE
5><META
6NAME="GENERATOR"
7CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8"><LINK
9REL="HOME"
10TITLE="SDL Library Documentation"
11HREF="index.html"><LINK
12REL="UP"
13TITLE="Multi-threaded Programming"
14HREF="thread.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_CondWait"
17HREF="sdlcondwait.html"><LINK
18REL="NEXT"
19TITLE="Time"
20HREF="time.html"></HEAD
21><BODY
22CLASS="REFENTRY"
23BGCOLOR="#FFF8DC"
24TEXT="#000000"
25LINK="#0000ee"
26VLINK="#551a8b"
27ALINK="#ff0000"
28><DIV
29CLASS="NAVHEADER"
30><TABLE
31SUMMARY="Header navigation table"
32WIDTH="100%"
33BORDER="0"
34CELLPADDING="0"
35CELLSPACING="0"
36><TR
37><TH
38COLSPAN="3"
39ALIGN="center"
40>SDL Library Documentation</TH
41></TR
42><TR
43><TD
44WIDTH="10%"
45ALIGN="left"
46VALIGN="bottom"
47><A
48HREF="sdlcondwait.html"
49ACCESSKEY="P"
50>Prev</A
51></TD
52><TD
53WIDTH="80%"
54ALIGN="center"
55VALIGN="bottom"
56></TD
57><TD
58WIDTH="10%"
59ALIGN="right"
60VALIGN="bottom"
61><A
62HREF="time.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLCONDWAITTIMEOUT"
74></A
75>SDL_CondWaitTimeout</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN8393"
80></A
81><H2
82>Name</H2
83>SDL_CondWaitTimeout&nbsp;--&nbsp;Wait on a condition variable, with timeout</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN8396"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN8397"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"
101#include "SDL_thread.h"</PRE
102><P
103><CODE
104><CODE
105CLASS="FUNCDEF"
106>int <B
107CLASS="FSFUNC"
108>SDL_CondWaitTimeout</B
109></CODE
110>(SDL_cond *cond, SDL_mutex *mutex, Uint32 ms);</CODE
111></P
112><P
113></P
114></DIV
115></DIV
116><DIV
117CLASS="REFSECT1"
118><A
119NAME="AEN8403"
120></A
121><H2
122>Description</H2
123><P
124>Wait on the condition variable <TT
125CLASS="PARAMETER"
126><I
127>cond</I
128></TT
129> for, at most, <TT
130CLASS="PARAMETER"
131><I
132>ms</I
133></TT
134> milliseconds. <TT
135CLASS="PARAMETER"
136><I
137>mut</I
138></TT
139> is unlocked so it must be locked when the function is called. Returns <TT
140CLASS="LITERAL"
141>SDL_MUTEX_TIMEDOUT</TT
142> if the condition is not signalled in the allotted time, <SPAN
143CLASS="RETURNVALUE"
144>0</SPAN
145> if it was signalled or <SPAN
146CLASS="RETURNVALUE"
147>-1</SPAN
148> on an error.</P
149></DIV
150><DIV
151CLASS="REFSECT1"
152><A
153NAME="AEN8412"
154></A
155><H2
156>See Also</H2
157><P
158><A
159HREF="sdlcondwait.html"
160><TT
161CLASS="FUNCTION"
162>SDL_CondWait</TT
163></A
164></P
165></DIV
166><DIV
167CLASS="NAVFOOTER"
168><HR
169ALIGN="LEFT"
170WIDTH="100%"><TABLE
171SUMMARY="Footer navigation table"
172WIDTH="100%"
173BORDER="0"
174CELLPADDING="0"
175CELLSPACING="0"
176><TR
177><TD
178WIDTH="33%"
179ALIGN="left"
180VALIGN="top"
181><A
182HREF="sdlcondwait.html"
183ACCESSKEY="P"
184>Prev</A
185></TD
186><TD
187WIDTH="34%"
188ALIGN="center"
189VALIGN="top"
190><A
191HREF="index.html"
192ACCESSKEY="H"
193>Home</A
194></TD
195><TD
196WIDTH="33%"
197ALIGN="right"
198VALIGN="top"
199><A
200HREF="time.html"
201ACCESSKEY="N"
202>Next</A
203></TD
204></TR
205><TR
206><TD
207WIDTH="33%"
208ALIGN="left"
209VALIGN="top"
210>SDL_CondWait</TD
211><TD
212WIDTH="34%"
213ALIGN="center"
214VALIGN="top"
215><A
216HREF="thread.html"
217ACCESSKEY="U"
218>Up</A
219></TD
220><TD
221WIDTH="33%"
222ALIGN="right"
223VALIGN="top"
224>Time</TD
225></TR
226></TABLE
227></DIV
228></BODY
229></HTML
230>