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_get_set_status.man,v $
29 .\" Revision 2.6 93/05/10 19:31:22 rvb
30 .\" updated
31 .\" [93/04/21 16:03:32 lli]
32 .\"
33 .\" Revision 2.5 91/12/11 08:43:01 jsb
34 .\" Changed <mach/mach.h> to <mach.h>.
35 .\" [91/11/25 10:55:30 rpd]
36 .\"
37 .\" Revision 2.4 91/05/14 17:06:37 mrt
38 .\" Correcting copyright
39 .\"
40 .\" Revision 2.3 91/02/14 14:11:29 mrt
41 .\" Changed to new Mach copyright
42 .\" [91/02/12 18:11:39 mrt]
43 .\"
44 .\" Revision 2.2 90/08/07 18:37:05 rpd
45 .\" Created.
46 .\"
47 .TH mach_port_get_set_status 2 9/19/86
48 .CM 4
49 .SH NAME
50 .nf
51 mach_port_get_set_status \- returns the members of a port set
52 .SH SYNOPSIS
53 .nf
54 .ft B
55 #include <mach.h>
56
57 kern_return_t
58 mach_port_get_set_status(task, name, members, count)
59 mach_port_t task;
60 mach_port_t name;
61 mach_port_array_t *members; /* out array */
62 mach_msg_type_number_t *count; /* out */
63 .fi
64 .ft P
65 .SH ARGUMENTS
66 .TP 12
67 .B
68 task
69 The task holding the port set.
70 .TP 12
71 .B
72 name
73 The task's name for the port set.
74 .TP 12
75 .B
76 members
77 The task's names for the port set's members.
78 .TP 12
79 .B
80 count
81 The number of member names returned.
82 .SH DESCRIPTION
83 \fBmach_port_get_set_status\fR returns the members of a port set.
84 \fBmembers\fR is an array that is automatically allocated when the
85 reply message is received. The user should \fBvm_deallocate\fR it when
86 the data is no longer needed.
87 .SH DIAGNOSTICS
88 .TP 25
89 KERN_SUCCESS
90 The call succeeded.
91 .TP 25
92 KERN_INVALID_TASK
93 \fBtask\fR was invalid.
94 .TP 25
95 KERN_INVALID_NAME
96 \fBname\fR did not denote a right.
97 .TP 25
98 KERN_INVALID_RIGHT
99 \fBname\fR denoted a right, but not a port set.
100 .TP 25
101 KERN_RESOURCE_SHORTAGE
102 The kernel ran out of memory.
103 .PP
104 The \fBmach_port_get_set_status\fR call is actually an RPC to \fBtask\fR,
105 normally a send right for a task port, but potentially any send right.
106 In addition to the normal diagnostic
107 return codes from the call's server (normally the kernel),
108 the call may return \fBmach_msg(2)\fR return codes.
109 .SH SEE ALSO
110 mach_port_move_member(2), vm_deallocate(2).
Cache object: f5ea2308122403c4c28674b15514aafb
|