0,0 → 1,222 |
<HTML |
><HEAD |
><TITLE |
>SDL_CondWaitTimeout</TITLE |
><META |
NAME="GENERATOR" |
CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
"><LINK |
REL="HOME" |
TITLE="SDL Library Documentation" |
HREF="index.html"><LINK |
REL="UP" |
TITLE="Multi-threaded Programming" |
HREF="thread.html"><LINK |
REL="PREVIOUS" |
TITLE="SDL_CondWait" |
HREF="sdlcondwait.html"><LINK |
REL="NEXT" |
TITLE="Time" |
HREF="time.html"></HEAD |
><BODY |
CLASS="REFENTRY" |
BGCOLOR="#FFF8DC" |
TEXT="#000000" |
LINK="#0000ee" |
VLINK="#551a8b" |
ALINK="#ff0000" |
><DIV |
CLASS="NAVHEADER" |
><TABLE |
WIDTH="100%" |
BORDER="0" |
CELLPADDING="0" |
CELLSPACING="0" |
><TR |
><TH |
COLSPAN="3" |
ALIGN="center" |
>SDL Library Documentation</TH |
></TR |
><TR |
><TD |
WIDTH="10%" |
ALIGN="left" |
VALIGN="bottom" |
><A |
HREF="sdlcondwait.html" |
>Prev</A |
></TD |
><TD |
WIDTH="80%" |
ALIGN="center" |
VALIGN="bottom" |
></TD |
><TD |
WIDTH="10%" |
ALIGN="right" |
VALIGN="bottom" |
><A |
HREF="time.html" |
>Next</A |
></TD |
></TR |
></TABLE |
><HR |
ALIGN="LEFT" |
WIDTH="100%"></DIV |
><H1 |
><A |
NAME="SDLCONDWAITTIMEOUT" |
>SDL_CondWaitTimeout</A |
></H1 |
><DIV |
CLASS="REFNAMEDIV" |
><A |
NAME="AEN7844" |
></A |
><H2 |
>Name</H2 |
>SDL_CondWaitTimeout -- Wait on a condition variable, with timeout</DIV |
><DIV |
CLASS="REFSYNOPSISDIV" |
><A |
NAME="AEN7847" |
></A |
><H2 |
>Synopsis</H2 |
><DIV |
CLASS="FUNCSYNOPSIS" |
><A |
NAME="AEN7848" |
></A |
><P |
></P |
><PRE |
CLASS="FUNCSYNOPSISINFO" |
>#include "SDL.h" |
#include "SDL_thread.h"</PRE |
><P |
><CODE |
><CODE |
CLASS="FUNCDEF" |
>int <B |
CLASS="FSFUNC" |
>SDL_CondWaitTimeout</B |
></CODE |
>(SDL_cond *cond, SDL_mutex *mutex, Uint32 ms);</CODE |
></P |
><P |
></P |
></DIV |
></DIV |
><DIV |
CLASS="REFSECT1" |
><A |
NAME="AEN7854" |
></A |
><H2 |
>Description</H2 |
><P |
>Wait on the condition variable <TT |
CLASS="PARAMETER" |
><I |
>cond</I |
></TT |
> for, at most, <TT |
CLASS="PARAMETER" |
><I |
>ms</I |
></TT |
> milliseconds. <TT |
CLASS="PARAMETER" |
><I |
>mut</I |
></TT |
> is unlocked so it must be locked when the function is called. Returns <TT |
CLASS="LITERAL" |
>SDL_MUTEX_TIMEDOUT</TT |
> if the condition is not signalled in the allotted time, <SPAN |
CLASS="RETURNVALUE" |
>0</SPAN |
> if it was signalled or <SPAN |
CLASS="RETURNVALUE" |
>-1</SPAN |
> on an error.</P |
></DIV |
><DIV |
CLASS="REFSECT1" |
><A |
NAME="AEN7863" |
></A |
><H2 |
>See Also</H2 |
><P |
><A |
HREF="sdlcondwait.html" |
><TT |
CLASS="FUNCTION" |
>SDL_CondWait</TT |
></A |
></P |
></DIV |
><DIV |
CLASS="NAVFOOTER" |
><HR |
ALIGN="LEFT" |
WIDTH="100%"><TABLE |
WIDTH="100%" |
BORDER="0" |
CELLPADDING="0" |
CELLSPACING="0" |
><TR |
><TD |
WIDTH="33%" |
ALIGN="left" |
VALIGN="top" |
><A |
HREF="sdlcondwait.html" |
>Prev</A |
></TD |
><TD |
WIDTH="34%" |
ALIGN="center" |
VALIGN="top" |
><A |
HREF="index.html" |
>Home</A |
></TD |
><TD |
WIDTH="33%" |
ALIGN="right" |
VALIGN="top" |
><A |
HREF="time.html" |
>Next</A |
></TD |
></TR |
><TR |
><TD |
WIDTH="33%" |
ALIGN="left" |
VALIGN="top" |
>SDL_CondWait</TD |
><TD |
WIDTH="34%" |
ALIGN="center" |
VALIGN="top" |
><A |
HREF="thread.html" |
>Up</A |
></TD |
><TD |
WIDTH="33%" |
ALIGN="right" |
VALIGN="top" |
>Time</TD |
></TR |
></TABLE |
></DIV |
></BODY |
></HTML |
> |