diff docs/html/sdlmutexp.html @ 0:74212992fb08

Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/html/sdlmutexp.html	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,233 @@
+<HTML
+><HEAD
+><TITLE
+>SDL_mutexP</TITLE
+><META
+NAME="GENERATOR"
+CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+"><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_DestroyMutex"
+HREF="sdldestroymutex.html"><LINK
+REL="NEXT"
+TITLE="SDL_mutexV"
+HREF="sdlmutexv.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="sdldestroymutex.html"
+>Prev</A
+></TD
+><TD
+WIDTH="80%"
+ALIGN="center"
+VALIGN="bottom"
+></TD
+><TD
+WIDTH="10%"
+ALIGN="right"
+VALIGN="bottom"
+><A
+HREF="sdlmutexv.html"
+>Next</A
+></TD
+></TR
+></TABLE
+><HR
+ALIGN="LEFT"
+WIDTH="100%"></DIV
+><H1
+><A
+NAME="SDLMUTEXP"
+>SDL_mutexP</A
+></H1
+><DIV
+CLASS="REFNAMEDIV"
+><A
+NAME="AEN7247"
+></A
+><H2
+>Name</H2
+>SDL_mutexP&nbsp;--&nbsp;Lock a mutex</DIV
+><DIV
+CLASS="REFSYNOPSISDIV"
+><A
+NAME="AEN7250"
+></A
+><H2
+>Synopsis</H2
+><DIV
+CLASS="FUNCSYNOPSIS"
+><A
+NAME="AEN7251"
+></A
+><P
+></P
+><PRE
+CLASS="FUNCSYNOPSISINFO"
+>#include "SDL.h"
+#include "SDL_thread.h"</PRE
+><P
+><CODE
+><CODE
+CLASS="FUNCDEF"
+>int <B
+CLASS="FSFUNC"
+>SDL_mutexP</B
+></CODE
+>(SDL_mutex *mutex);</CODE
+></P
+><P
+></P
+></DIV
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN7257"
+></A
+><H2
+>Description</H2
+><P
+>Locks the <TT
+CLASS="PARAMETER"
+><I
+>mutex</I
+></TT
+>, which was previously created with <A
+HREF="sdlcreatemutex.html"
+><TT
+CLASS="FUNCTION"
+>SDL_CreateMutex</TT
+></A
+>. If the mutex is already locked then <TT
+CLASS="FUNCTION"
+>SDL_mutexP</TT
+> will not return until it is <A
+HREF="sdlmutexv.html"
+>unlocked</A
+>. Returns <SPAN
+CLASS="RETURNVALUE"
+>0</SPAN
+> on success, or <SPAN
+CLASS="RETURNVALUE"
+>-1</SPAN
+> on an error.</P
+><P
+>SDL also defines a macro <TT
+CLASS="LITERAL"
+>#define SDL_LockMutex(m) SDL_mutexP(m)</TT
+>.</P
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN7269"
+></A
+><H2
+>See Also</H2
+><P
+><A
+HREF="sdlcreatemutex.html"
+><TT
+CLASS="FUNCTION"
+>SDL_CreateMutex</TT
+></A
+>,
+<A
+HREF="sdlmutexv.html"
+><TT
+CLASS="FUNCTION"
+>SDL_mutexV</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="sdldestroymutex.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="sdlmutexv.html"
+>Next</A
+></TD
+></TR
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+>SDL_DestroyMutex</TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="thread.html"
+>Up</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+>SDL_mutexV</TD
+></TR
+></TABLE
+></DIV
+></BODY
+></HTML
+>
\ No newline at end of file