xdiff-string-merge3.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.xdiff-string-merge3" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xdiff_string_merge3</refname>
  <refpurpose>Merge 3 strings into one</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>xdiff_string_merge3</methodname>
   <methodparam><type>string</type><parameter>old_data</parameter></methodparam>
   <methodparam><type>string</type><parameter>new_data1</parameter></methodparam>
   <methodparam><type>string</type><parameter>new_data2</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">error</parameter></methodparam>
  </methodsynopsis>
  <para>
   Merges three strings into one and returns the result.
   The <parameter>old_data</parameter> is an original version of data 
   while <parameter>new_data1</parameter> and <parameter>new_data2</parameter> are modified 
   versions of an original. An optional <parameter>error</parameter> is used to pass any
   rejected parts during merging process.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>old_data</parameter></term>
     <listitem>
      <para>
       First string with data. It acts as "old" data.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>new_data1</parameter></term>
     <listitem>
      <para>
       Second string with data. It acts as modified version of <parameter>old_data</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>new_data2</parameter></term>
     <listitem>
      <para>
       Third string with data. It acts as modified version of <parameter>old_data</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>error</parameter></term>
     <listitem>
      <para>
       If provided then rejected parts are stored inside this variable.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the merged string, &false; if an internal error happened, or &true;
   if merged string is empty.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>xdiff_file_merge3</function></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
-->