docs/man3/SDL_RemoveTimer.3
author Sam Lantinga <slouken@libsdl.org>
Wed, 08 Mar 2006 18:30:12 +0000
changeset 1486 9d77fc9d0ace
parent 181 e5bc29de3f0a
child 2283 546f7c1eb755
permissions -rw-r--r--
Re-added C runtime support for Visual C++ 5,6
slouken@181
     1
.TH "SDL_RemoveTimer" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
slouken@0
     2
.SH "NAME"
slouken@0
     3
SDL_RemoveTimer\- Remove a timer which was added with \fISDL_AddTimer\fR\&.
slouken@0
     4
.SH "SYNOPSIS"
slouken@0
     5
.PP
slouken@0
     6
\fB#include "SDL\&.h"
slouken@0
     7
.sp
slouken@0
     8
\fBSDL_bool \fBSDL_RemoveTimer\fP\fR(\fBSDL_TimerID id\fR);
slouken@0
     9
.SH "DESCRIPTION"
slouken@0
    10
.PP
slouken@0
    11
Removes a timer callback previously added with \fISDL_AddTimer\fR\&.
slouken@0
    12
.SH "RETURN VALUE"
slouken@0
    13
.PP
slouken@0
    14
Returns a boolean value indicating success\&.
slouken@0
    15
.SH "EXAMPLES"
slouken@0
    16
.PP
slouken@0
    17
.PP
slouken@0
    18
.nf
slouken@0
    19
\f(CWSDL_RemoveTimer(my_timer_id);\fR
slouken@0
    20
.fi
slouken@0
    21
.PP
slouken@0
    22
.SH "SEE ALSO"
slouken@0
    23
.PP
slouken@0
    24
\fI\fBSDL_AddTimer\fP\fR
slouken@181
    25
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01