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_set_seqno.man,v $
29 .\" Revision 2.3 93/05/10 19:31:50 rvb
30 .\" updated
31 .\" [93/04/21 16:04:05 lli]
32 .\"
33 .\" Revision 2.2 91/12/11 08:43:23 jsb
34 .\" Created.
35 .\" [91/11/25 rpd]
36 .\"
37 .TH mach_port_set_seqno 2 1/13/87
38 .CM 4
39 .SH NAME
40 .nf
41 mach_port_set_seqno \- changes the sequence number of a port
42 .SH SYNOPSIS
43 .nf
44 .ft B
45 #include <mach.h>
46
47 kern_return_t
48 mach_port_set_seqno(task, name, seqno)
49 mach_port_t task;
50 mach_port_t name;
51 mach_port_seqno_t seqno;
52 .fi
53 .ft P
54 .SH ARGUMENTS
55 .TP 12
56 .B
57 task
58 The task owning the receive right.
59 .TP 12
60 .B
61 name
62 \fBtask\fR's name for the receive right.
63 .TP 12
64 .B
65 seqno
66 The sequence number for the next message received from the port.
67 .SH DESCRIPTION
68 \fBmach_port_set_seqno\fR changes a port's sequence number.
69 The specified \fBtask\fR must hold a receive right
70 (named \fBname\fR) for the port.
71
72 All sequence number values are valid.
73 The next message received from the port will be stamped
74 with the specified sequence number.
75 .SH DIAGNOSTICS
76 .TP 25
77 KERN_SUCCESS
78 The call succeeded.
79 .TP 25
80 KERN_INVALID_TASK
81 \fBtask\fR was invalid.
82 .TP 25
83 KERN_INVALID_NAME
84 \fBname\fR did not denote a right.
85 .TP 25
86 KERN_INVALID_RIGHT
87 \fBname\fR denoted a right, but not a receive right.
88 .PP
89 The \fBmach_port_set_seqno\fR call is actually an RPC to \fBtask\fR,
90 normally a send right for a task port, but potentially any send right.
91 In addition to the normal diagnostic
92 return codes from the call's server (normally the kernel),
93 the call may return \fBmach_msg(2)\fR return codes.
94 .SH SEE ALSO
95 mach_port_get_receive_status(2).
Cache object: 3929704d31bc699fdb989a96371a6fb2
|