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