1 .\"
2 .\" Mach Operating System
3 .\" Copyright (c) 1993 Carnegie Mellon University
4 .\" All Rights Reserved.
5 .\"
6 .\" Permission to use, copy, modify and distribute this software and its
7 .\" documentation is hereby granted, provided that both the copyright
8 .\" notice and this permission notice appear in all copies of the
9 .\" software, derivative works or modified versions, and any portions
10 .\" thereof, and that both notices appear in supporting documentation.
11 .\"
12 .\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
13 .\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
14 .\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
15 .\"
16 .\" Carnegie Mellon requests users of this software to return to
17 .\"
18 .\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
19 .\" School of Computer Science
20 .\" Carnegie Mellon University
21 .\" Pittsburgh PA 15213-3890
22 .\"
23 .\" any improvements or extensions that they make and grant Carnegie Mellon
24 .\" the rights to redistribute these changes.
25 .\"
26 .\"
27 .\" HISTORY
28 .\" $Log: timer_terminate.man,v $
29 .\" Revision 2.2 93/12/07 14:01:52 dbg
30 .\" Created.
31 .\"
32 .\"
33 .TH timer_terminate 2 9/22/93
34 .CM 4
35 .SH NAME
36 .nf
37 timer_terminate \- destroy a timer.
38 .SH SYNOPSIS
39 .nf
40 .ft B
41 #include <mach.h>
42
43 .nf
44 .ft B
45 kern_return_t
46 timer_terminate(
47 mach_timer_t timer);
48
49
50 .fi
51 .ft P
52 .SH ARGUMENTS
53 .TP 15
54 .B
55 timer
56 The timer to destroy.
57
58 .SH DESCRIPTION
59 .B timer_terminate
60 destroys a timer. If a thread is sleeping on the timer, the
61 thread is awakened. If the timer is armed (by timer_arm),
62 the event to occur will not happen.
63
64 A timer is also terminated if no send rights remain to the
65 timer's port.
66
67 .SH DIAGNOSTICS
68 .TP 25
69 KERN_SUCCESS
70 Operation completed successfully
71 .TP 25
72 KERN_INVALID_ARGUMENT
73 .B timer
74 is not a timer.
75
76 .SH BUGS
77
78 .SH SEE ALSO
79 .B timer_create, timer_arm, timer_sleep, timer_cancel.
80
Cache object: 9f5c63149d8d975d62e6752f0e2feed6
|