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_create.man,v $
29 .\" Revision 2.2 93/12/07 14:01:19 dbg
30 .\" Created.
31 .\"
32 .\"
33 .TH timer_create 2 9/22/93
34 .CM 4
35 .SH NAME
36 .nf
37 timer_create \- create 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_create(
47 mach_clock_t clock,
48 mach_timer_t *timer); /* out */
49
50
51 .fi
52 .ft P
53 .SH ARGUMENTS
54 .TP 15
55 .B
56 clock
57 The clock device to provide timekeeping for the timer.
58 .TP 15
59 .B
60 timer
61 Returns the newly created timer.
62
63 .SH DESCRIPTION
64 A timer is based on a particular clock device, which provides
65 timekeeping for that timer at a particular (or selectable) resolution.
66 .B timer_create
67 creates a timer based on the supplied clock device.
68
69 .SH DIAGNOSTICS
70 .TP 25
71 KERN_SUCCESS
72 Operation completed successfully
73 .TP 25
74 KERN_INVALID_ARGUMENT
75 .B clock
76 is not a clock device.
77
78 .SH BUGS
79
80 .SH SEE ALSO
81 .B timer_terminate, timer_arm, timer_sleep, timer_cancel.
82
Cache object: 74425550bb3534de9eb6c92dc2114434
|