1 .\"
2 .\" Mach Operating System
3 .\" Copyright (c) 1991,1990 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: task_suspend.man,v $
29 .\" Revision 2.5 93/03/18 15:15:23 mrt
30 .\" corrected types
31 .\" [93/03/12 16:53:32 lli]
32 .\"
33 .\" Revision 2.4 91/05/14 17:13:12 mrt
34 .\" Correcting copyright
35 .\"
36 .\" Revision 2.3 91/02/14 14:14:49 mrt
37 .\" Changed to new Mach copyright
38 .\" [91/02/12 18:15:42 mrt]
39 .\"
40 .\" Revision 2.2 90/08/07 18:44:37 rpd
41 .\" Created.
42 .\"
43 .TH task_suspend 2 9/19/86
44 .CM 4
45 .SH NAME
46 .nf
47 task_suspend \- suspends specified task
48 .SH SYNOPSIS
49 .nf
50 .ft B
51 #include <mach.h>
52
53 .nf
54 .ft B
55 kern_return_t task_suspend(target_task)
56 mach_port_t target_task;
57
58
59 .fi
60 .ft P
61 .SH ARGUMENTS
62 .TP 15
63 .B
64 target_task
65 The task to be suspended.
66
67 .SH DESCRIPTION
68 Increments the task's suspend count and stops all
69 threads in the task. As long as the suspend count is
70 positive newly created threads will not run.
71 This call does not return until all threads are suspended.
72
73 The count
74 may become greater than one, with the effect that it
75 will take more than one resume call to restart the task.
76
77 .SH DIAGNOSTICS
78 .TP 25
79 KERN_SUCCESS
80 The task has been suspended.
81 .TP 25
82 KERN_INVALID_ARGUMENT
83 .B target_task
84 is not a task.
85
86 .SH SEE ALSO
87 .B task_create, task_terminate, task_resume, task_info,
88 .B thread_suspend
89
90
91
92
Cache object: 1a5b97bd35b22dbe7c784d8004ed89d5
|