1
0
mirror of https://github.com/php/doc-es.git synced 2026-03-26 00:12:06 +01:00
Files
archived-doc-es/reference/hwapi/hw_api/checkout.xml
2014-09-05 20:55:10 +00:00

99 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: regiemix Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="hwapi.checkout">
<refnamediv>
<refname>hw_api::checkout</refname>
<refpurpose>Verifica un objeto</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>hw_api::checkout</methodname>
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
</methodsynopsis>
<para>
Esta función verifica un objeto o una jerarquía entera de objetos.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>parameter</parameter></term>
<listitem>
<para>
El parámetro es un array que contiene el elemento obligatorio
'objectIdentifier' y el elemento opcional 'version', 'mode'
y 'objectQuery'. 'mode' puede tomar uno de los valores siguientes:
<variablelist>
<varlistentry>
<term><constant>HW_API_CHECKIN_NORMAL</constant></term>
<listitem>
<simpara>
Verifica un objeto. El objeto debe ser un documento.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>HW_API_CHECKIN_RECURSIVE</constant></term>
<listitem>
<simpara>
Si el objeto a verificar es una colección, todos sus hijos serán
verificados recursivamente si son documentos. El intento de verificar
una colección devolvería un error.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</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="hwapi.checkin" /></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
-->