docs/man3/SDL_CondWaitTimeout.3
author Sam Lantinga <slouken@libsdl.org>
Wed, 08 Mar 2006 18:30:12 +0000
changeset 1486 9d77fc9d0ace
parent 181 e5bc29de3f0a
child 2283 546f7c1eb755
permissions -rw-r--r--
Re-added C runtime support for Visual C++ 5,6
slouken@181
     1
.TH "SDL_CondWaitTimeout" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" 
slouken@0
     2
.SH "NAME"
slouken@0
     3
SDL_CondWaitTimeout\- Wait on a condition variable, with timeout
slouken@0
     4
.SH "SYNOPSIS"
slouken@0
     5
.PP
slouken@0
     6
\fB#include "SDL\&.h"
slouken@0
     7
#include "SDL_thread\&.h"
slouken@0
     8
.sp
slouken@0
     9
\fBint \fBSDL_CondWaitTimeout\fP\fR(\fBSDL_cond *cond, SDL_mutex *mutex, Uint32 ms\fR);
slouken@0
    10
.SH "DESCRIPTION"
slouken@0
    11
.PP
slouken@0
    12
Wait on the condition variable \fBcond\fR for, at most, \fBms\fR milliseconds\&. \fBmut\fR is unlocked so it must be locked when the function is called\&. Returns \fBSDL_MUTEX_TIMEDOUT\fP if the condition is not signalled in the allotted time, \fB0\fR if it was signalled or \fB-1\fR on an error\&.
slouken@0
    13
.SH "SEE ALSO"
slouken@0
    14
.PP
slouken@0
    15
\fI\fBSDL_CondWait\fP\fR
slouken@181
    16
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00