php-doc-en/reference/hw/functions/hw-getandlock.xml

49 lines
1.4 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<refentry id="function.hw-getandlock">
<refnamediv>
<refname>hw_GetAndLock</refname>
<refpurpose>Return object record and lock object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>hw_getandlock</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns the object record for the object with ID
<parameter>objectID</parameter>.
It will also lock the object, so other users cannot access
it until it is unlocked.
</para>
<para>
See also <function>hw_unlock</function>,
and <function>hw_getobject</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
-->