Commit 72a0cc4f authored by Per Cederqvist's avatar Per Cederqvist

(get-membership-old): Use a "want-read-texts : BOOL" argument instead

	of "mask : BITSTRING(want-read-texts)".  The result is the
	same, but using BOOL makes the prototype easier to read.
	Document the argument more verbosely.
(get-membership): Do likewise.
(login): Do likewise for the "invisible" argument.
(create-anonymous-text-old): Added @misc{} markup.
parent 9c78d7a0
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
@c @c
@c FIXME: Explain how the garb works with nice and keep-commented @c FIXME: Explain how the garb works with nice and keep-commented
@c @c
@c $Id: Protocol-A.texi,v 1.110 2001/04/18 08:22:11 ceder Exp $ @c $Id: Protocol-A.texi,v 1.111 2001/04/18 21:08:32 ceder Exp $
@c %**start of header @c %**start of header
@setfilename protocol-a.info @setfilename protocol-a.info
@settitle LysKOM Protocol A @settitle LysKOM Protocol A
...@@ -5434,13 +5434,10 @@ Messages have been disabled. ...@@ -5434,13 +5434,10 @@ Messages have been disabled.
@findex get-membership-old @findex get-membership-old
@example @example
get-membership-old [46] (( person : Pers-No; get-membership-old [46] (( person : Pers-No;
first : INT16; first : INT16;
no-of-confs : INT16; no-of-confs : INT16;
mask : BITSTRING want-read-texts : BOOL ))
(
want-read-texts
); ))
-> ( ARRAY Membership-Old ); -> ( ARRAY Membership-Old );
@end example @end example
...@@ -5448,9 +5445,10 @@ This call retrieves the membership record for a list of conferences for ...@@ -5448,9 +5445,10 @@ This call retrieves the membership record for a list of conferences for
a single person. @rarg{person} is the person whose memberships are to be a single person. @rarg{person} is the person whose memberships are to be
retrieved. @rarg{first} is the first position in the membership list to retrieved. @rarg{first} is the first position in the membership list to
retrieve, numbered from 0 and up. @rarg{no-of-confs} is the number of retrieve, numbered from 0 and up. @rarg{no-of-confs} is the number of
membership records to retrieve. @rarg{mask} is a set of flags. Currently membership records to retrieve. If @rarg{want-read-texts} is @samp{0}
the only flag is @rarg{want-read-texts}, which instructs the server not the server will not send the contents of the @field{read-texts} array
to send the @field{read-texts} array of the memberships. of the memberships. (The size will be transmitted, but a single
asterisk (@samp{*}) will be sent instead of the array itself.)
The server will return a membership list that is shorter than The server will return a membership list that is shorter than
@rarg{no-of-confs} if @rarg{no-of-confs} + @rarg{first} is larger than @rarg{no-of-confs} if @rarg{no-of-confs} + @rarg{first} is larger than
...@@ -5471,12 +5469,14 @@ zero.) ...@@ -5471,12 +5469,14 @@ zero.)
@t{=1 1 @{ 20 14 22 17 6 97 4 197 1 6 100 2 0 * @}} @t{=1 1 @{ 20 14 22 17 6 97 4 197 1 6 100 2 0 * @}}
@end example @end example
In this example we retrieve the memberships of person 5. The first call In this example we retrieve the memberships of person 5. The first
asks for three memberships, starting with number 0. Since this person is call asks for three memberships, starting with number 0. Since this
only a member of two conferences, the list returned only contains two person is only a member of two conferences, the list returned only
memberships. The next two calls retrieve a single membership each. The contains two memberships. (An extra newline has been inserted in the
first by asking for only one, and the second by asking for four result of the first call to make the result more readable.) The next
memberships, starting with number 1. two calls retrieve a single membership each, the first by asking for
only one, and the second by asking for four memberships, starting with
number 1.
@subheading Error codes @subheading Error codes
...@@ -6014,8 +6014,9 @@ explicit support for sending anonymous texts to a server. ...@@ -6014,8 +6014,9 @@ explicit support for sending anonymous texts to a server.
It is only possible to send anonymous texts to a conference with the It is only possible to send anonymous texts to a conference with the
right flag bit set. right flag bit set.
The only Misc-Info items valid for this call are recpt, cc-recpt, The only Misc-Info items valid for this call in the @rarg{misc-info}
bcc-recpt (protocol version 10) comm-to and footn-to. array are @misc{recpt}, @misc{cc-recpt}, @misc{bcc-recpt} (introducted
in protocol version 10), @misc{comm-to} and @misc{footn-to}.
@example @example
1 28 20HExample\nMessage body 3 @{ 0 5 1 112 2 33467 @} 1 28 20HExample\nMessage body 3 @{ 0 5 1 112 2 33467 @}
...@@ -6141,18 +6142,15 @@ There is no text preceding text @rarg{start}. ...@@ -6141,18 +6142,15 @@ There is no text preceding text @rarg{start}.
@example @example
login [62] (( person : Pers-No; login [62] (( person : Pers-No;
passwd : HOLLERITH; passwd : HOLLERITH;
visibility : BITSTRING invisible : BOOL ))
(
is-invisible;
); ))
-> ( ); -> ( );
@end example @end example
This call is used to log in. The session is logged in as person number This call is used to log in. The session is logged in as person number
@rarg{person} if @rarg{passwd} is the correct password for that person. @rarg{person} if @rarg{passwd} is the correct password for that person.
If @rarg{is-invisible} is true, the session is invisible. It will not be If @rarg{invisible} is true, the session is invisible. It will not be
returned by @req{who-is-on} and @req{who-is-on-ident} and the returned by @req{who-is-on} and @req{who-is-on-ident} and the
invisible flag of the dynamic session info (@pxref{LysKOM Data Types} dynamic session info (@pxref{LysKOM Data Types}
will have the invisible flag set. will have the invisible flag set.
Invisible sessions are primarily used by software agents that do not act Invisible sessions are primarily used by software agents that do not act
...@@ -7512,23 +7510,22 @@ privileges to find out if @rarg{person} is a member. ...@@ -7512,23 +7510,22 @@ privileges to find out if @rarg{person} is a member.
@findex get-membership @findex get-membership
@example @example
get-membership [99] (( person : Pers-No; get-membership [99] (( person : Pers-No;
first : INT16; first : INT16;
no-of-confs : INT16; no-of-confs : INT16;
mask : BITSTRING want-read-texts : BOOL ))
(
want-read-texts
); ))
-> ( ARRAY Membership ); -> ( ARRAY Membership );
@end example @end example
This call retrieves the membership record for a list of conferences for This call retrieves the membership record for a list of conferences
a single person. @rarg{person} is the person whose memberships are to be for a single person. @rarg{person} is the person whose memberships are
retrieved. @rarg{first} is the first position in the membership list to to be retrieved. @rarg{first} is the first position in the membership
retrieve, numbered from 0 and up. @rarg{no-of-confs} is the number of list to retrieve, numbered from 0 and up. @rarg{no-of-confs} is the
membership records to retrieve. @rarg{mask} is a set of flags. Currently number of membership records to retrieve. If @rarg{want-read-texts} is
the only flag is @rarg{want-read-texts}, which instructs the server not @samp{0}, the server will not send the contents of the
to send the @field{read-texts} array of the memberships. @field{read-texts} array of the memberships. (The size will be
transmitted, but a single asterisk (@samp{*}) will be sent instead of
the array itself.)
The server will return a membership list that is shorter than The server will return a membership list that is shorter than
@rarg{no-of-confs} if @rarg{no-of-confs} + @rarg{first} is larger than @rarg{no-of-confs} if @rarg{no-of-confs} + @rarg{first} is larger than
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment