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