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

<?xml version='1.0' encoding='iso-8859-1' ?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
  <refentry id="function.hwapi-unlock">
   <refnamediv>
    <refname>hw_api->unlock</refname>
    <refpurpose>Unlocks a locked object</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>object</type><methodname>unlock</methodname>
     <methodparam><type>array</type><parameter>parameter</parameter></methodparam>
    </methodsynopsis>
    <para>
     Unlocks a locked object. Only the user who has locked the object and the
     system user may unlock an object. The parameter array contains the
     required element 'objectIdentifier' and the optional parameters
     'mode' and 'objectquery'. The meaning of 'mode' is the same as in
     function <function>hwapi_lock</function>.
    </para>
    <para>
     Returns &true; on success or an object of class HW_API_Error.
    </para>
    <para>
     See also <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
-->