[PHP-DOC] cvs: phpdoc /en/functions session.xml

[jim winstead]

jimw            Thu Dec  6 20:12:34 2001 EDT

  Modified files:              
    /phpdoc/en/functions        session.xml 
  Log:
  incorporate notes for session_delete.
  
Index: phpdoc/en/functions/session.xml
diff -u phpdoc/en/functions/session.xml:1.58 phpdoc/en/functions/session.xml:1.59
--- phpdoc/en/functions/session.xml:1.58        Mon Dec  3 16:58:59 2001
+++ phpdoc/en/functions/session.xml     Thu Dec  6 20:12:34 2001
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.58 $ -->
+<!-- $Revision: 1.59 $ -->
  <reference id="ref.session">
   <title>Session handling functions</title>
   <titleabbrev>Sessions</titleabbrev>
@@ -384,13 +384,35 @@
     </funcsynopsis>
     <simpara>
      <function>session_destroy</function> destroys all of the data
-     associated with the current session.
+     associated with the current session. It does not unset any of
+     the global variables associated with the session, or unset the
+     session cookie.
     </simpara>
     <simpara>
      This function returns &true; on success and 
      &false; on failure to destroy
      the session data.
     </simpara>
+    <para>
+     <example>
+      <title>Destroying a session</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+
+# Initialize the session.
+# If you are using session_name("something"), don't forget it now!
+session_start();
+# Unset all of the session variables.
+session_unset();
+# Finally, destroy the session.
+session_destroy();
+
+?>
+]]>
+      </programlisting>
+     </example>
+    </para>
    </refsect1>
   </refentry>