wddx-packet-start.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.wddx-packet-start" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>wddx_packet_start</refname>
  <refpurpose>Starts a new WDDX packet with structure inside it</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
  &warn.removed.function-7-4-0;
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>wddx_packet_start</methodname>
   <methodparam choice="opt"><type>string</type><parameter>comment</parameter></methodparam>
  </methodsynopsis>
  <para>
   Start a new WDDX packet for incremental addition of variables.
   It automatically creates a structure definition inside the packet to
   contain the variables.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>comment</parameter></term>
     <listitem>
      <para>
       An optional comment string.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a packet ID for use in later functions, or &false; on error.
  </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
-->