1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
.TH SP_LEAVE 3 "JULY 1998" SPREAD "User Manuals"
.SH NAME
SP_leave \- create connection between app and daemon
.SH SYNOPSIS
.B #include <sp.h>
.br
.BI "int SP_leave( mailbox " mbox ", const char *" group );
.SH DESCRIPTION
.B SP_leave
leaves a group with the name passed as the string
.I group.
If the group does not exist amoung the Spread daemons this
operation is ignored, otherwise the Leave leaves the existing group.
The
.I mbox
of the connection upon which to leave a group is the first parameter.</P>
The
.I group
string represents the name of the group to leave.
.SH "RETURN VALUES"
Returns 0 on success or one of the following errors ( < 0 ):
.TP 0.8i
.B ILLEGAL_GROUP
The
.I group
given to leave was illegal for some reason. Usually because it was of
length 0 or length > MAX_GROUP_NAME
.TP
.B ILLEGAL_SESSION
The session specified by
.I mbox
is illegal. Usually because it is not active.
.TP
.B CONNECTION_CLOSED
During communication errors occured
and the leave could not be initiated.
.SH BUGS
None.
.SH AUTHOR
Yair Amir <yairamir@cnds.jhu.edu>
.br
Jonathan Stanton <jonathan@cnds.jhu.edu>
.br
Commedia Project <commedia@cnds.jhu.edu>
.SH "SEE ALSO"
.BR libsp (3)
|
