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

81 lines
2.1 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.hw-getchildcoll" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetChildColl</refname>
<refpurpose>Object ids of child collections</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>hw_getchildcoll</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns object ids. Each object ID belongs to a child collection of the
collection with ID <parameter>objectID</parameter>. The function will not
return child documents.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of object ids.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_children</function></member>
<member><function>hw_getchilddoccoll</function></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:"../../../../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
-->