mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 10:58:54 +00:00
fe3023e897
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@166685 c90b9560-bf6c-de11-be94-00142212c4b1
66 lines
2 KiB
XML
66 lines
2 KiB
XML
<?xml version='1.0' encoding='iso-8859-1' ?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
|
|
<refentry id="function.hwapi-checkout">
|
|
<refnamediv>
|
|
<refname>hw_api->checkout</refname>
|
|
<refpurpose>Checks out an object</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>object</type><methodname>hw_api->checkout</methodname>
|
|
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function checks out an object or a whole hierarchy of objects.
|
|
The parameters array contains the required element
|
|
'objectIdentifier' and the optional element 'version', 'mode'
|
|
and 'objectQuery'. 'mode' can be one of the following values:
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><constant>HW_API_CHECKIN_NORMAL</constant></term>
|
|
<listitem>
|
|
<simpara>
|
|
Checks out an object. The object must be a document.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><constant>HW_API_CHECKIN_RECURSIVE</constant></term>
|
|
<listitem>
|
|
<simpara>
|
|
If the object to check out is a collection, all children will be
|
|
checked out recursively if they are documents. Trying to check out
|
|
a collection would result in an error.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
<para>
|
|
See also <function>hwapi_checkin</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
|
|
-->
|