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: mach_port_move_member.man,v $
29 .\" Revision 2.6 93/05/10 19:31:31 rvb
30 .\" updated
31 .\" [93/04/21 16:03:46 lli]
32 .\"
33 .\" Revision 2.5 91/12/11 08:43:08 jsb
34 .\" Changed <mach/mach.h> to <mach.h>.
35 .\" [91/11/25 10:55:44 rpd]
36 .\"
37 .\" Revision 2.4 91/05/14 17:07:02 mrt
38 .\" Correcting copyright
39 .\"
40 .\" Revision 2.3 91/02/14 14:11:39 mrt
41 .\" Changed to new Mach copyright
42 .\" [91/02/12 18:11:52 mrt]
43 .\"
44 .\" Revision 2.2 90/08/07 18:37:24 rpd
45 .\" Created.
46 .\"
47 .TH mach_port_move_member 2 9/19/86
48 .CM 4
49 .SH NAME
50 .nf
51 mach_port_move_member \- moves a receive right into/out of a port set
52 .SH SYNOPSIS
53 .nf
54 .ft B
55 #include <mach.h>
56
57 kern_return_t
58 mach_port_move_member(task, member, after)
59 mach_port_t task;
60 mach_port_t member;
61 mach_port_t after;
62 .fi
63 .ft P
64 .SH ARGUMENTS
65 .TP 12
66 .B
67 task
68 The task holding the port set and receive right.
69 .TP 12
70 .B
71 member
72 The task's name for the receive right.
73 .TP 12
74 .B
75 after
76 The task's name for the port set.
77 .SH DESCRIPTION
78 \fBmach_port_move_member\fR
79 moves a receive right into a port set.
80 If the receive right is already a member of another port set,
81 it is removed from that set first.
82 If the port set is MACH_PORT_NULL, then the receive right
83 is not put into a port set, but removed from its current port set.
84 .SH DIAGNOSTICS
85 .TP 25
86 KERN_SUCCESS
87 The call succeeded.
88 .TP 25
89 KERN_INVALID_TASK
90 \fBtask\fR was invalid.
91 .TP 25
92 KERN_INVALID_NAME
93 \fBmember\fR did not denote a right.
94 .TP 25
95 KERN_INVALID_RIGHT
96 \fBmember\fR denoted a right, but not a receive right.
97 .TP 25
98 KERN_INVALID_NAME
99 \fBafter\fR did not denote a right.
100 .TP 25
101 KERN_INVALID_RIGHT
102 \fBafter\fR denoted a right, but not a port set.
103 .TP 25
104 KERN_NOT_IN_SET
105 \fBafter\fR was MACH_PORT_NULL, but \fBmember\fR wasn't
106 currently in a port set.
107 .PP
108 The \fBmach_port_move_member\fR call is actually an RPC to \fBtask\fR,
109 normally a send right for a task port, but potentially any send right.
110 In addition to the normal diagnostic
111 return codes from the call's server (normally the kernel),
112 the call may return \fBmach_msg(2)\fR return codes.
113 .SH SEE ALSO
114 mach_port_get_set_status(2), mach_port_get_receive_status(2).
Cache object: c3ea7da18b47def39175976c7bd9421b
|