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

56 lines
1.9 KiB
XML
Raw Normal View History

<?xml version='1.0' encoding='iso-8859-1' ?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
<refentry id="function.hwapi-unlock">
<refnamediv>
<refname>hw_api->unlock</refname>
<refpurpose>D&eacute;verrouille un objet HyperWave verrouill&eacute;</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>object</type><methodname>hw_api->unlock</methodname>
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
</methodsynopsis>
<para>
<function>hw_api->unlock</function> d&eacute;verrouille un objet verrouill&eacute;.
Seul, l'utilisateur qui a verrouill&eacute; un objet et l'administrateur
syst&egrave;me, peuvent le d&eacute;verrouiller. Le param&egrave;tre <parameter>parameter</parameter>
est un tableau qui contient les &eacute;l&eacute;ments obligatoires de
<literal>objectIdentifier</literal> et les param&egrave;tres optionnels
de <literal>mode</literal> et <literal>objectquery</literal>. La
signification de <literal>mode</literal> est la m&ecirc;me que dans la
fonction <function>hwapi_lock</function>.
</para>
<para>
<function>hw_api->unlock</function> retourne &true; en cas de
succ&egrave;s, et sinon, un objet d'erreur HW_API_Error.
</para>
<para>
Voir aussi
<function>hwapi_lock</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
-->