aboutsummaryrefslogtreecommitdiffstats
path: root/distrib/sdl-1.2.15/docs/man3/SDL_SemPost.3
diff options
context:
space:
mode:
Diffstat (limited to 'distrib/sdl-1.2.15/docs/man3/SDL_SemPost.3')
-rw-r--r--distrib/sdl-1.2.15/docs/man3/SDL_SemPost.328
1 files changed, 28 insertions, 0 deletions
diff --git a/distrib/sdl-1.2.15/docs/man3/SDL_SemPost.3 b/distrib/sdl-1.2.15/docs/man3/SDL_SemPost.3
new file mode 100644
index 0000000..5487d2d
--- /dev/null
+++ b/distrib/sdl-1.2.15/docs/man3/SDL_SemPost.3
@@ -0,0 +1,28 @@
+.TH "SDL_SemPost" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
+.SH "NAME"
+SDL_SemPost \- Unlock a semaphore\&.
+.SH "SYNOPSIS"
+.PP
+\fB#include "SDL\&.h"
+#include "SDL_thread\&.h"
+.sp
+\fBint \fBSDL_SemPost\fP\fR(\fBSDL_sem *sem\fR);
+.SH "DESCRIPTION"
+.PP
+\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\&.
+.PP
+\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\&.
+.SH "RETURN VALUE"
+.PP
+Returns \fB0\fR if successful or \fB-1\fR if there was an error (leaving the semaphore unchanged)\&.
+.SH "EXAMPLES"
+.PP
+.PP
+.nf
+\f(CWSDL_SemPost(my_sem);\fR
+.fi
+.PP
+.SH "SEE ALSO"
+.PP
+\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
+.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00