Files
doc-fr/reference/hwapi/functions/hwapi-lock.xml
Damien Seguy 79c7478ede minor spelling mistakes and literalisatin
git-svn-id: https://svn.php.net/repository/phpdoc/fr/trunk@259743 c90b9560-bf6c-de11-be94-00142212c4b1
2008-05-14 11:21:55 +00:00

94 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- EN-Revision: 1.11 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.hwapi-lock">
<refnamediv>
<refname>hw_api->lock</refname>
<refpurpose>Verrouille un objet</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>hw_api</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>lock</methodname>
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
Verrouille un objet pour le faire éditer exclusivement par l'utilisateur
qui appelle cette fonction. L'objet ne peut être déverrouillé que par cet
utilisateur ou par le système.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>parameter</parameter></term>
<listitem>
<para>
Le paramètre <parameter>parameter</parameter> est un tableau
qui contient l'élément obligatoire <literal>"objectIdentifier"</literal> et les paramètres
optionnels <literal>"mode"</literal> et <literal>"objectquery"</literal>.
</para>
<para>
<literal>"mode"</literal> détermine comment l'objet
est verrouillé. <constant>HW_API_LOCK_NORMAL</constant> signifie que
l'objet est verrouillé jusqu'à son déverrouillage.
<constant>HW_API_LOCK_RECURSIVE</constant> est uniquement valide pour une collection
et verrouille tous les objets de la collection et des sous-collections.
<constant>HW_API_LOCK_SESSION</constant> signifie que l'objet est verrouillé
aussi longtemps que tient la session en cours.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.hwapi-unlock" /></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:"../../../../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
-->