sdlremovetimer.html
1
2
3
4
5
6
<HTML
><HEAD
><TITLE
>SDL_RemoveTimer</TITLE
><META
NAME="GENERATOR"
7
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Time"
HREF="time.html"><LINK
REL="PREVIOUS"
TITLE="SDL_AddTimer"
HREF="sdladdtimer.html"><LINK
REL="NEXT"
TITLE="SDL_SetTimer"
HREF="sdlsettimer.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
31
SUMMARY="Header navigation table"
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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="sdladdtimer.html"
49
ACCESSKEY="P"
50
51
52
53
54
55
56
57
58
59
60
61
62
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlsettimer.html"
63
ACCESSKEY="N"
64
65
66
67
68
69
70
71
72
73
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLREMOVETIMER"
74
75
></A
>SDL_RemoveTimer</H1
76
77
78
><DIV
CLASS="REFNAMEDIV"
><A
79
NAME="AEN8526"
80
81
82
83
84
85
86
87
88
89
90
></A
><H2
>Name</H2
>SDL_RemoveTimer -- Remove a timer which was added with
<A
HREF="sdladdtimer.html"
>SDL_AddTimer</A
>.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
91
NAME="AEN8530"
92
93
94
95
96
97
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
98
NAME="AEN8531"
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>SDL_bool <B
CLASS="FSFUNC"
>SDL_RemoveTimer</B
></CODE
>(SDL_TimerID id);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
122
NAME="AEN8537"
123
124
125
126
127
128
129
130
131
132
133
134
135
></A
><H2
>Description</H2
><P
>Removes a timer callback previously added with
<A
HREF="sdladdtimer.html"
>SDL_AddTimer</A
>.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
136
NAME="AEN8541"
137
138
139
140
141
142
143
144
145
></A
><H2
>Return Value</H2
><P
>Returns a boolean value indicating success.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
146
NAME="AEN8544"
147
148
149
150
151
152
153
154
155
156
157
158
></A
><H2
>Examples</H2
><P
><PRE
CLASS="PROGRAMLISTING"
>SDL_RemoveTimer(my_timer_id);</PRE
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
159
NAME="AEN8548"
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
></A
><H2
>See Also</H2
><P
><A
HREF="sdladdtimer.html"
><TT
CLASS="FUNCTION"
>SDL_AddTimer</TT
></A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
177
SUMMARY="Footer navigation table"
178
179
180
181
182
183
184
185
186
187
188
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdladdtimer.html"
189
ACCESSKEY="P"
190
191
192
193
194
195
196
197
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
198
ACCESSKEY="H"
199
200
201
202
203
204
205
206
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlsettimer.html"
207
ACCESSKEY="N"
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_AddTimer</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="time.html"
223
ACCESSKEY="U"
224
225
226
227
228
229
230
231
232
233
234
235
236
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_SetTimer</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>