home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue2 / SDL.ARC / sdlhtmldox / sdlremovet < prev    next >
Encoding:
Text File  |  2001-05-09  |  2.7 KB  |  228 lines
  1. <HTML
  2. ><HEAD
  3. ><TITLE
  4. >SDL_RemoveTimer</TITLE
  5. ><META
  6. NAME="GENERATOR"
  7. CONTENT="Modular DocBook HTML Stylesheet Version 1.64
  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. WIDTH="100%"
  32. BORDER="0"
  33. CELLPADDING="0"
  34. CELLSPACING="0"
  35. ><TR
  36. ><TH
  37. COLSPAN="3"
  38. ALIGN="center"
  39. >SDL Library Documentation</TH
  40. ></TR
  41. ><TR
  42. ><TD
  43. WIDTH="10%"
  44. ALIGN="left"
  45. VALIGN="bottom"
  46. ><A
  47. HREF="sdladdtimer.html"
  48. >Prev</A
  49. ></TD
  50. ><TD
  51. WIDTH="80%"
  52. ALIGN="center"
  53. VALIGN="bottom"
  54. ></TD
  55. ><TD
  56. WIDTH="10%"
  57. ALIGN="right"
  58. VALIGN="bottom"
  59. ><A
  60. HREF="sdlsettimer.html"
  61. >Next</A
  62. ></TD
  63. ></TR
  64. ></TABLE
  65. ><HR
  66. ALIGN="LEFT"
  67. WIDTH="100%"></DIV
  68. ><H1
  69. ><A
  70. NAME="SDLREMOVETIMER"
  71. >SDL_RemoveTimer</A
  72. ></H1
  73. ><DIV
  74. CLASS="REFNAMEDIV"
  75. ><A
  76. NAME="AEN7983"
  77. ></A
  78. ><H2
  79. >Name</H2
  80. >SDL_RemoveTimer -- Remove a timer which was added with
  81. <A
  82. HREF="sdladdtimer.html"
  83. >SDL_AddTimer</A
  84. >.</DIV
  85. ><DIV
  86. CLASS="REFSYNOPSISDIV"
  87. ><A
  88. NAME="AEN7987"
  89. ></A
  90. ><H2
  91. >Synopsis</H2
  92. ><DIV
  93. CLASS="FUNCSYNOPSIS"
  94. ><A
  95. NAME="AEN7988"
  96. ></A
  97. ><P
  98. ></P
  99. ><PRE
  100. CLASS="FUNCSYNOPSISINFO"
  101. >#include "SDL.h"</PRE
  102. ><P
  103. ><CODE
  104. ><CODE
  105. CLASS="FUNCDEF"
  106. >SDL_bool <B
  107. CLASS="FSFUNC"
  108. >SDL_RemoveTimer</B
  109. ></CODE
  110. >(SDL_TimerID id);</CODE
  111. ></P
  112. ><P
  113. ></P
  114. ></DIV
  115. ></DIV
  116. ><DIV
  117. CLASS="REFSECT1"
  118. ><A
  119. NAME="AEN7994"
  120. ></A
  121. ><H2
  122. >Description</H2
  123. ><P
  124. >Removes a timer callback previously added with
  125. <A
  126. HREF="sdladdtimer.html"
  127. >SDL_AddTimer</A
  128. >.</P
  129. ></DIV
  130. ><DIV
  131. CLASS="REFSECT1"
  132. ><A
  133. NAME="AEN7998"
  134. ></A
  135. ><H2
  136. >Return Value</H2
  137. ><P
  138. >Returns a boolean value indicating success.</P
  139. ></DIV
  140. ><DIV
  141. CLASS="REFSECT1"
  142. ><A
  143. NAME="AEN8001"
  144. ></A
  145. ><H2
  146. >Examples</H2
  147. ><P
  148. ><PRE
  149. CLASS="PROGRAMLISTING"
  150. >SDL_RemoveTimer(my_timer_id);</PRE
  151. ></P
  152. ></DIV
  153. ><DIV
  154. CLASS="REFSECT1"
  155. ><A
  156. NAME="AEN8005"
  157. ></A
  158. ><H2
  159. >See Also</H2
  160. ><P
  161. ><A
  162. HREF="sdladdtimer.html"
  163. ><TT
  164. CLASS="FUNCTION"
  165. >SDL_AddTimer</TT
  166. ></A
  167. ></P
  168. ></DIV
  169. ><DIV
  170. CLASS="NAVFOOTER"
  171. ><HR
  172. ALIGN="LEFT"
  173. WIDTH="100%"><TABLE
  174. WIDTH="100%"
  175. BORDER="0"
  176. CELLPADDING="0"
  177. CELLSPACING="0"
  178. ><TR
  179. ><TD
  180. WIDTH="33%"
  181. ALIGN="left"
  182. VALIGN="top"
  183. ><A
  184. HREF="sdladdtimer.html"
  185. >Prev</A
  186. ></TD
  187. ><TD
  188. WIDTH="34%"
  189. ALIGN="center"
  190. VALIGN="top"
  191. ><A
  192. HREF="index.html"
  193. >Home</A
  194. ></TD
  195. ><TD
  196. WIDTH="33%"
  197. ALIGN="right"
  198. VALIGN="top"
  199. ><A
  200. HREF="sdlsettimer.html"
  201. >Next</A
  202. ></TD
  203. ></TR
  204. ><TR
  205. ><TD
  206. WIDTH="33%"
  207. ALIGN="left"
  208. VALIGN="top"
  209. >SDL_AddTimer</TD
  210. ><TD
  211. WIDTH="34%"
  212. ALIGN="center"
  213. VALIGN="top"
  214. ><A
  215. HREF="time.html"
  216. >Up</A
  217. ></TD
  218. ><TD
  219. WIDTH="33%"
  220. ALIGN="right"
  221. VALIGN="top"
  222. >SDL_SetTimer</TD
  223. ></TR
  224. ></TABLE
  225. ></DIV
  226. ></BODY
  227. ></HTML
  228. >