<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.session-encode" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>session_encode</refname>
  <refpurpose>Encodes the current session data as a session encoded string</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>session_encode</methodname>
   <void/>
  </methodsynopsis>
  <para>
   <function>session_encode</function> returns a serialized string of the
   contents of the current session data stored in the $_SESSION superglobal.
  </para>
  <para>
   By default, the serialization method used is internal to PHP, and is not the same as <function>serialize</function>.
   The serialization method can be set using <link linkend="ini.session.serialize-handler">session.serialize_handler</link>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the contents of the current session encoded, &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <warning>
   <para>
    Must call <function>session_start</function> before using <function>session_encode</function>.
   </para>
  </warning>
 </refsect1> 
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>session_decode</function></member>
    <member><link linkend="ini.session.serialize-handler">session.serialize_handler</link></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
