SDL-1.2.14
[sdl_omap.git] / docs / man3 / SDL_RemoveTimer.3
CommitLineData
e14743d1 1.TH "SDL_RemoveTimer" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
2.SH "NAME"
3SDL_RemoveTimer \- Remove a timer which was added with \fISDL_AddTimer\fR\&.
4.SH "SYNOPSIS"
5.PP
6\fB#include "SDL\&.h"
7.sp
8\fBSDL_bool \fBSDL_RemoveTimer\fP\fR(\fBSDL_TimerID id\fR);
9.SH "DESCRIPTION"
10.PP
11Removes a timer callback previously added with \fISDL_AddTimer\fR\&.
12.SH "RETURN VALUE"
13.PP
14Returns a boolean value indicating success\&.
15.SH "EXAMPLES"
16.PP
17.PP
18.nf
19\f(CWSDL_RemoveTimer(my_timer_id);\fR
20.fi
21.PP
22.SH "SEE ALSO"
23.PP
24\fI\fBSDL_AddTimer\fP\fR
25.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01