mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
2fd3f0c96d
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297078 c90b9560-bf6c-de11-be94-00142212c4b1
87 lines
2.3 KiB
XML
87 lines
2.3 KiB
XML
<?xml version='1.0' encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.hwapi-lock">
|
|
<refnamediv>
|
|
<refname>hw_api->lock</refname>
|
|
<refpurpose>Locks an object</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>
|
|
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.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>parameter</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The parameter array contains the required element 'objectIdentifier'
|
|
and the optional parameters 'mode' and 'objectquery'.
|
|
</para>
|
|
<para>
|
|
'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>
|
|
</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:"~/.phpdoc/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
|
|
-->
|