php-doc-en/reference/hwapi/functions/hwapi-checkout.xml

<?xml version='1.0' encoding='iso-8859-1' ?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
  <refentry id="function.hwapi-checkout">
   <refnamediv>
    <refname>hw_api->checkout</refname>
    <refpurpose>Extrait un objet</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>object</type><methodname>checkout</methodname>
     <methodparam><type>array</type><parameter>parameter</parameter></methodparam>
    </methodsynopsis>
    <para>
     <methodname>hw_api->checkout</methodname> extrait un objet ou
     toute une hi&eacute;rarchie d'objets. Le param&egrave;tre <parameter>parameter</parameter>
     contient l'&eacute;l&eacute;ment obligatoire 'objectIdentifier' et les &eacute;l&eacute;ments
     optionnels 'version', 'mode' et 'objectQuery'. 'mode' peut prendre l'une des
     valeurs suivantes :
     <variablelist>
      <varlistentry>
       <term><constant>HW_API_CHECKIN_NORMAL</constant></term>
       <listitem>
        <simpara>
         Extrait un objet. L'objet doit &ecirc;tre un document.
        </simpara>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><constant>HW_API_CHECKIN_RECURSIVE</constant></term>
       <listitem>
        <simpara>
         Si l'objet &agrave; extraire est une collection, tous les fils seront
         extraits r&eacute;cursivement, si ce sont des documents. Extraire une
         collection g&eacute;n&eacute;rera une erreur.
        </simpara>
       </listitem>
      </varlistentry>
     </variablelist>
    </para>
    <para>
     Voir aussi
     <function>hwapi_checkin</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
-->