sdlmutexp.html revision 9682c8870b8ff5e4ac2e4c70b759f791c6f38c1f 
1<HTML
2><HEAD
3><TITLE
4>SDL_mutexP</TITLE
5><META
6NAME="GENERATOR"
7CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8"><LINK
9REL="HOME"
10TITLE="SDL Library Documentation"
11HREF="index.html"><LINK
12REL="UP"
13TITLE="Multi-threaded Programming"
14HREF="thread.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_DestroyMutex"
17HREF="sdldestroymutex.html"><LINK
18REL="NEXT"
19TITLE="SDL_mutexV"
20HREF="sdlmutexv.html"></HEAD
21><BODY
22CLASS="REFENTRY"
23BGCOLOR="#FFF8DC"
24TEXT="#000000"
25LINK="#0000ee"
26VLINK="#551a8b"
27ALINK="#ff0000"
28><DIV
29CLASS="NAVHEADER"
30><TABLE
31SUMMARY="Header navigation table"
32WIDTH="100%"
33BORDER="0"
34CELLPADDING="0"
35CELLSPACING="0"
36><TR
37><TH
38COLSPAN="3"
39ALIGN="center"
40>SDL Library Documentation</TH
41></TR
42><TR
43><TD
44WIDTH="10%"
45ALIGN="left"
46VALIGN="bottom"
47><A
48HREF="sdldestroymutex.html"
49ACCESSKEY="P"
50>Prev</A
51></TD
52><TD
53WIDTH="80%"
54ALIGN="center"
55VALIGN="bottom"
56></TD
57><TD
58WIDTH="10%"
59ALIGN="right"
60VALIGN="bottom"
61><A
62HREF="sdlmutexv.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLMUTEXP"
74></A
75>SDL_mutexP</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN7872"
80></A
81><H2
82>Name</H2
83>SDL_mutexP&nbsp;--&nbsp;Lock a mutex</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN7875"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN7876"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"
101#include "SDL_thread.h"</PRE
102><P
103><CODE
104><CODE
105CLASS="FUNCDEF"
106>int <B
107CLASS="FSFUNC"
108>SDL_mutexP</B
109></CODE
110>(SDL_mutex *mutex);</CODE
111></P
112><P
113></P
114></DIV
115></DIV
116><DIV
117CLASS="REFSECT1"
118><A
119NAME="AEN7882"
120></A
121><H2
122>Description</H2
123><P
124>Locks the <TT
125CLASS="PARAMETER"
126><I
127>mutex</I
128></TT
129>, which was previously created with <A
130HREF="sdlcreatemutex.html"
131><TT
132CLASS="FUNCTION"
133>SDL_CreateMutex</TT
134></A
135>. If the mutex is already locked then <TT
136CLASS="FUNCTION"
137>SDL_mutexP</TT
138> will not return until it is <A
139HREF="sdlmutexv.html"
140>unlocked</A
141>. Returns <SPAN
142CLASS="RETURNVALUE"
143>0</SPAN
144> on success, or <SPAN
145CLASS="RETURNVALUE"
146>-1</SPAN
147> on an error.</P
148><P
149>SDL also defines a macro <TT
150CLASS="LITERAL"
151>#define SDL_LockMutex(m) SDL_mutexP(m)</TT
152>.</P
153></DIV
154><DIV
155CLASS="REFSECT1"
156><A
157NAME="AEN7894"
158></A
159><H2
160>See Also</H2
161><P
162><A
163HREF="sdlcreatemutex.html"
164><TT
165CLASS="FUNCTION"
166>SDL_CreateMutex</TT
167></A
168>,
169<A
170HREF="sdlmutexv.html"
171><TT
172CLASS="FUNCTION"
173>SDL_mutexV</TT
174></A
175></P
176></DIV
177><DIV
178CLASS="NAVFOOTER"
179><HR
180ALIGN="LEFT"
181WIDTH="100%"><TABLE
182SUMMARY="Footer navigation table"
183WIDTH="100%"
184BORDER="0"
185CELLPADDING="0"
186CELLSPACING="0"
187><TR
188><TD
189WIDTH="33%"
190ALIGN="left"
191VALIGN="top"
192><A
193HREF="sdldestroymutex.html"
194ACCESSKEY="P"
195>Prev</A
196></TD
197><TD
198WIDTH="34%"
199ALIGN="center"
200VALIGN="top"
201><A
202HREF="index.html"
203ACCESSKEY="H"
204>Home</A
205></TD
206><TD
207WIDTH="33%"
208ALIGN="right"
209VALIGN="top"
210><A
211HREF="sdlmutexv.html"
212ACCESSKEY="N"
213>Next</A
214></TD
215></TR
216><TR
217><TD
218WIDTH="33%"
219ALIGN="left"
220VALIGN="top"
221>SDL_DestroyMutex</TD
222><TD
223WIDTH="34%"
224ALIGN="center"
225VALIGN="top"
226><A
227HREF="thread.html"
228ACCESSKEY="U"
229>Up</A
230></TD
231><TD
232WIDTH="33%"
233ALIGN="right"
234VALIGN="top"
235>SDL_mutexV</TD
236></TR
237></TABLE
238></DIV
239></BODY
240></HTML
241>