[interchange-docs] xmldocs - racke modified refs/userdb.tag

[docs at icdevgroup.org]

User:      racke
Date:      2008-10-03 10:58:15 GMT
Modified:  refs     userdb.tag
Log:
logout function documented

Revision  Changes    Path
1.6                  xmldocs/refs/userdb.tag


rev 1.6, prev_rev 1.5
Index: userdb.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/userdb.tag,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- userdb.tag	1 Oct 2008 18:05:34 -0000	1.5
+++ userdb.tag	3 Oct 2008 10:58:15 -0000	1.6
@@ -87,6 +87,31 @@
 
 __NAME__ description
 <tag>userdb</tag> provides access to &glos-UserDB; functions.
+<refsect2>
+<title>Logout function</title>
+<para>
+<literal>[userdb logout]</literal> performs log out operation on the current
+user account:
+<programlisting>
+[userdb logout]
+</programlisting>  
+Usually, data stored in the session should be removed at the same time:
+<programlisting>
+[userdb function=logout clear=1]
+[userdb function=logout clear_session=1]
+[userdb function=logout clear_cookie="MV_PASSWORD"]
+</programlisting>
+</para><para>
+<literal>clear=1</literal> resets all &glos-value; and &glos-scratch;
+variables initialized by the &glos-UserDB;.
+</para><para>
+<literal>clear_session=1</literal> forces the creation of an entirely new
+session for the user.
+</para><para>
+<literal>clear_cookie="<replaceable>NAME</replaceable>"</literal> expires
+the &glos-cookie; <replaceable>NAME</replaceable>.
+</para>
+</refsect2>
 __END__
 
 __NAME__ example: Save cart