mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
6a9d174b80
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@173025 c90b9560-bf6c-de11-be94-00142212c4b1
54 lines
1.8 KiB
XML
54 lines
1.8 KiB
XML
<?xml version='1.0' encoding='iso-8859-1' ?>
|
|
<!-- $Revision: 1.8 $ -->
|
|
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
|
<refentry id="function.hwapi-lock">
|
|
<refnamediv>
|
|
<refname>hw_api->lock</refname>
|
|
<refpurpose>Locks an object</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>hw_api->lock</methodname>
|
|
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Locks an object for exclusive editing by the user calling this function.
|
|
The object can be only unlocked by this user or the system user. The
|
|
parameter array contains the required element 'objectIdentifier' and the
|
|
optional parameters 'mode' and 'objectquery'.
|
|
'mode' determines how an object is locked.
|
|
<constant>HW_API_LOCK_NORMAL</constant> means,
|
|
an object is locked until it is unlocked.
|
|
<constant>HW_API_LOCK_RECURSIVE</constant>
|
|
is only valid for collection and locks all objects
|
|
within the collection and possible subcollections.
|
|
<constant>HW_API_LOCK_SESSION</constant> means, an
|
|
object is locked only as long as the session is valid.
|
|
</para>
|
|
<para>
|
|
See also <function>hwapi_unlock</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
|
|
-->
|