• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_DestroySemaphore</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_CreateSemaphore"
17HREF="sdlcreatesemaphore.html"><LINK
18REL="NEXT"
19TITLE="SDL_SemWait"
20HREF="sdlsemwait.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="sdlcreatesemaphore.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="sdlsemwait.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLDESTROYSEMAPHORE"
74></A
75>SDL_DestroySemaphore</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN7982"
80></A
81><H2
82>Name</H2
83>SDL_DestroySemaphore&nbsp;--&nbsp;Destroys a semaphore that was created by <A
84HREF="sdlcreatesemaphore.html"
85>SDL_CreateSemaphore</A
86>.</DIV
87><DIV
88CLASS="REFSYNOPSISDIV"
89><A
90NAME="AEN7986"
91></A
92><H2
93>Synopsis</H2
94><DIV
95CLASS="FUNCSYNOPSIS"
96><A
97NAME="AEN7987"
98></A
99><P
100></P
101><PRE
102CLASS="FUNCSYNOPSISINFO"
103>#include "SDL.h"
104#include "SDL_thread.h"</PRE
105><P
106><CODE
107><CODE
108CLASS="FUNCDEF"
109>void <B
110CLASS="FSFUNC"
111>SDL_DestroySemaphore</B
112></CODE
113>(SDL_sem *sem);</CODE
114></P
115><P
116></P
117></DIV
118></DIV
119><DIV
120CLASS="REFSECT1"
121><A
122NAME="AEN7993"
123></A
124><H2
125>Description</H2
126><P
127><TT
128CLASS="FUNCTION"
129>SDL_DestroySemaphore</TT
130> destroys the semaphore pointed to
131by <TT
132CLASS="PARAMETER"
133><I
134>sem</I
135></TT
136> that was created by
137<A
138HREF="sdlcreatesemaphore.html"
139><TT
140CLASS="FUNCTION"
141>SDL_CreateSemaphore</TT
142></A
143>.
144It is not safe to destroy a semaphore if there are threads currently blocked
145waiting on it.</P
146></DIV
147><DIV
148CLASS="REFSECT1"
149><A
150NAME="AEN8000"
151></A
152><H2
153>Examples</H2
154><P
155><PRE
156CLASS="PROGRAMLISTING"
157>if (my_sem != NULL) {
158        SDL_DestroySemaphore(my_sem);
159        my_sem = NULL;
160}</PRE
161></P
162></DIV
163><DIV
164CLASS="REFSECT1"
165><A
166NAME="AEN8004"
167></A
168><H2
169>See Also</H2
170><P
171><A
172HREF="sdlcreatesemaphore.html"
173><TT
174CLASS="FUNCTION"
175>SDL_CreateSemaphore</TT
176></A
177>,
178<A
179HREF="sdlsemwait.html"
180><TT
181CLASS="FUNCTION"
182>SDL_SemWait</TT
183></A
184>,
185<A
186HREF="sdlsemtrywait.html"
187><TT
188CLASS="FUNCTION"
189>SDL_SemTryWait</TT
190></A
191>,
192<A
193HREF="sdlsemwaittimeout.html"
194><TT
195CLASS="FUNCTION"
196>SDL_SemWaitTimeout</TT
197></A
198>,
199<A
200HREF="sdlsempost.html"
201><TT
202CLASS="FUNCTION"
203>SDL_SemPost</TT
204></A
205>,
206<A
207HREF="sdlsemvalue.html"
208><TT
209CLASS="FUNCTION"
210>SDL_SemValue</TT
211></A
212></P
213></DIV
214><DIV
215CLASS="NAVFOOTER"
216><HR
217ALIGN="LEFT"
218WIDTH="100%"><TABLE
219SUMMARY="Footer navigation table"
220WIDTH="100%"
221BORDER="0"
222CELLPADDING="0"
223CELLSPACING="0"
224><TR
225><TD
226WIDTH="33%"
227ALIGN="left"
228VALIGN="top"
229><A
230HREF="sdlcreatesemaphore.html"
231ACCESSKEY="P"
232>Prev</A
233></TD
234><TD
235WIDTH="34%"
236ALIGN="center"
237VALIGN="top"
238><A
239HREF="index.html"
240ACCESSKEY="H"
241>Home</A
242></TD
243><TD
244WIDTH="33%"
245ALIGN="right"
246VALIGN="top"
247><A
248HREF="sdlsemwait.html"
249ACCESSKEY="N"
250>Next</A
251></TD
252></TR
253><TR
254><TD
255WIDTH="33%"
256ALIGN="left"
257VALIGN="top"
258>SDL_CreateSemaphore</TD
259><TD
260WIDTH="34%"
261ALIGN="center"
262VALIGN="top"
263><A
264HREF="thread.html"
265ACCESSKEY="U"
266>Up</A
267></TD
268><TD
269WIDTH="33%"
270ALIGN="right"
271VALIGN="top"
272>SDL_SemWait</TD
273></TR
274></TABLE
275></DIV
276></BODY
277></HTML
278>