• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_RemoveTimer</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="Time"
14HREF="time.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_AddTimer"
17HREF="sdladdtimer.html"><LINK
18REL="NEXT"
19TITLE="SDL_SetTimer"
20HREF="sdlsettimer.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="sdladdtimer.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="sdlsettimer.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLREMOVETIMER"
74></A
75>SDL_RemoveTimer</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN8526"
80></A
81><H2
82>Name</H2
83>SDL_RemoveTimer&nbsp;--&nbsp;Remove a timer which was added with
84<A
85HREF="sdladdtimer.html"
86>SDL_AddTimer</A
87>.</DIV
88><DIV
89CLASS="REFSYNOPSISDIV"
90><A
91NAME="AEN8530"
92></A
93><H2
94>Synopsis</H2
95><DIV
96CLASS="FUNCSYNOPSIS"
97><A
98NAME="AEN8531"
99></A
100><P
101></P
102><PRE
103CLASS="FUNCSYNOPSISINFO"
104>#include "SDL.h"</PRE
105><P
106><CODE
107><CODE
108CLASS="FUNCDEF"
109>SDL_bool <B
110CLASS="FSFUNC"
111>SDL_RemoveTimer</B
112></CODE
113>(SDL_TimerID id);</CODE
114></P
115><P
116></P
117></DIV
118></DIV
119><DIV
120CLASS="REFSECT1"
121><A
122NAME="AEN8537"
123></A
124><H2
125>Description</H2
126><P
127>Removes a timer callback previously added with
128<A
129HREF="sdladdtimer.html"
130>SDL_AddTimer</A
131>.</P
132></DIV
133><DIV
134CLASS="REFSECT1"
135><A
136NAME="AEN8541"
137></A
138><H2
139>Return Value</H2
140><P
141>Returns a boolean value indicating success.</P
142></DIV
143><DIV
144CLASS="REFSECT1"
145><A
146NAME="AEN8544"
147></A
148><H2
149>Examples</H2
150><P
151><PRE
152CLASS="PROGRAMLISTING"
153>SDL_RemoveTimer(my_timer_id);</PRE
154></P
155></DIV
156><DIV
157CLASS="REFSECT1"
158><A
159NAME="AEN8548"
160></A
161><H2
162>See Also</H2
163><P
164><A
165HREF="sdladdtimer.html"
166><TT
167CLASS="FUNCTION"
168>SDL_AddTimer</TT
169></A
170></P
171></DIV
172><DIV
173CLASS="NAVFOOTER"
174><HR
175ALIGN="LEFT"
176WIDTH="100%"><TABLE
177SUMMARY="Footer navigation table"
178WIDTH="100%"
179BORDER="0"
180CELLPADDING="0"
181CELLSPACING="0"
182><TR
183><TD
184WIDTH="33%"
185ALIGN="left"
186VALIGN="top"
187><A
188HREF="sdladdtimer.html"
189ACCESSKEY="P"
190>Prev</A
191></TD
192><TD
193WIDTH="34%"
194ALIGN="center"
195VALIGN="top"
196><A
197HREF="index.html"
198ACCESSKEY="H"
199>Home</A
200></TD
201><TD
202WIDTH="33%"
203ALIGN="right"
204VALIGN="top"
205><A
206HREF="sdlsettimer.html"
207ACCESSKEY="N"
208>Next</A
209></TD
210></TR
211><TR
212><TD
213WIDTH="33%"
214ALIGN="left"
215VALIGN="top"
216>SDL_AddTimer</TD
217><TD
218WIDTH="34%"
219ALIGN="center"
220VALIGN="top"
221><A
222HREF="time.html"
223ACCESSKEY="U"
224>Up</A
225></TD
226><TD
227WIDTH="33%"
228ALIGN="right"
229VALIGN="top"
230>SDL_SetTimer</TD
231></TR
232></TABLE
233></DIV
234></BODY
235></HTML
236>