0
|
1 .TH "SDL_CondWaitTimeout" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference"
|
|
2 .SH "NAME"
|
|
3 SDL_CondWaitTimeout\- Wait on a condition variable, with timeout
|
|
4 .SH "SYNOPSIS"
|
|
5 .PP
|
|
6 \fB#include "SDL\&.h"
|
|
7 #include "SDL_thread\&.h"
|
|
8 .sp
|
|
9 \fBint \fBSDL_CondWaitTimeout\fP\fR(\fBSDL_cond *cond, SDL_mutex *mutex, Uint32 ms\fR);
|
|
10 .SH "DESCRIPTION"
|
|
11 .PP
|
|
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\&.
|
|
13 .SH "SEE ALSO"
|
|
14 .PP
|
|
15 \fI\fBSDL_CondWait\fP\fR
|
|
16 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03
|