Mercurial > sdl-ios-xcode

<HTML
><HEAD
><TITLE
>SDL_mutexP</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><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
SUMMARY="Header navigation 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"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlmutexv.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLMUTEXP"
></A
>SDL_mutexP</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN7872"
></A
><H2
>Name</H2
>SDL_mutexP&nbsp;--&nbsp;Lock a mutex</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN7875"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN7876"
></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="AEN7882"
></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="AEN7894"
></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
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdldestroymutex.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlmutexv.html"
ACCESSKEY="N"
>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"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_mutexV</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
author	Sam Lantinga <slouken@libsdl.org>
date	Fri, 28 Dec 2007 08:07:57 +0000
parents	355632dca928
children