php-doc-en/reference/hwapi/functions/hwapi-parents.xml
Jakub Vrana fe3023e897 Add object to methodname
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@166685 c90b9560-bf6c-de11-be94-00142212c4b1
2004-08-18 13:21:49 +00:00

51 lines
1.5 KiB
XML

<?xml version='1.0' encoding='iso-8859-1' ?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hwapi.xml, last change in rev 1.1 -->
<refentry id="function.hwapi-parents">
<refnamediv>
<refname>hw_api->parents</refname>
<refpurpose>Returns parents of an object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>hw_api->parents</methodname>
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
</methodsynopsis>
<para>
Retrieves the parents of an object. The parents can be further filtered by
specifying an object query. The parameter array
contains the required elements 'objectidentifier' and the
optional elements 'attributeselector' and 'objectquery'.
</para>
<para>
The return value is an array of objects of type
<classname>HW_API_Object</classname> or
<classname>HW_API_Error</classname>.
</para>
<para>
See also <function>hwapi_children</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
-->