<?xml version='1.0' encoding='iso-8859-1' ?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
  <refentry id="function.hwapi-replace">
   <refnamediv>
    <refname>hw_api->replace</refname>
    <refpurpose>Replaces an object</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>hw_api_object</type><methodname>hw_api->replace</methodname>
     <methodparam><type>array</type><parameter>parameter</parameter></methodparam>
    </methodsynopsis>
    <para>
     Replaces the attributes and the content of an object The parameter array
     contains the required elements 'objectIdentifier' and 'object' and
     the optional parameters 'content', 'parameters', 'mode' and
     'attributeSelector'. 'objectIdentifier' contains the object to be
     replaced. 'object' contains the new object. 'content' contains the new
     content. 'parameters' contain extra information for HTML documents.
     HTML_Language is the letter abbreviation of the language of the title.
     HTML_Base sets the base attribute of the HTML document. 'mode' can be a
     combination of the following flags:
     <variablelist>
      <varlistentry>
       <term><constant>HW_API_REPLACE_NORMAL</constant></term>
       <listitem>
        <simpara>
         The object on the server is replace with the object passed.
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><constant>HW_API_REPLACE_FORCE_VERSION_CONTROL</constant></term>
       <listitem>
        <simpara>
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><constant>HW_API_REPLACE_AUTOMATIC_CHECKOUT</constant></term>
       <listitem>
        <simpara>
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><constant>HW_API_REPLACE_AUTOMATIC_CHECKIN</constant></term>
       <listitem>
        <simpara>
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><constant>HW_API_REPLACE_PLAIN</constant></term>
       <listitem>
        <simpara>
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><constant>HW_API_REPLACE_REVERT_IF_NOT_CHANGED</constant></term>
       <listitem>
        <simpara>
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><constant>HW_API_REPLACE_KEEP_TIME_MODIFIED</constant></term>
       <listitem>
        <simpara>
        </simpara>
       </listitem>
      </varlistentry>
     </variablelist>
    </para>
    <para>
     See also <function>hwapi_insert</function>.
    </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:"../../../../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
-->