]> git.xonotic.org Git - xonotic/xonotic.git/blob - misc/builddeps/dp.win64/share/man/man3/SDL_SemPost.3
Handle errors right.
[xonotic/xonotic.git] / misc / builddeps / dp.win64 / share / man / man3 / SDL_SemPost.3
1 .TH "SDL_SemPost" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" 
2 .SH "NAME"
3 SDL_SemPost \- Unlock a semaphore\&.
4 .SH "SYNOPSIS"
5 .PP
6 \fB#include "SDL\&.h"
7 #include "SDL_thread\&.h"
8 .sp
9 \fBint \fBSDL_SemPost\fP\fR(\fBSDL_sem *sem\fR);
10 .SH "DESCRIPTION"
11 .PP
12 \fBSDL_SemPost\fP unlocks the semaphore pointed to by \fBsem\fR and atomically increments the semaphores value\&. Threads that were blocking on the semaphore may be scheduled after this call succeeds\&.
13 .PP
14 \fBSDL_SemPost\fP should be called after a semaphore is locked by a successful call to \fISDL_SemWait\fR, \fISDL_SemTryWait\fR or \fISDL_SemWaitTimeout\fR\&.
15 .SH "RETURN VALUE"
16 .PP
17 Returns \fB0\fR if successful or \fB-1\fR if there was an error (leaving the semaphore unchanged)\&.
18 .SH "EXAMPLES"
19 .PP
20 .PP
21 .nf
22 \f(CWSDL_SemPost(my_sem);\fR
23 .fi
24 .PP
25 .SH "SEE ALSO"
26 .PP
27 \fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemValue\fP\fR
28 .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00