php-doc-en/reference/hwapi/functions/hwapi-link.xml

50 lines
1.4 KiB
XML
Raw Normal View History

<?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-link">
<refnamediv>
<refname>hw_api->link</refname>
<refpurpose>Creates a link to an object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>object</type><methodname>hw_api->link</methodname>
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
</methodsynopsis>
<para>
Creates a link to an object. Accessing this link is like accessing the
object to links points to. The parameter array contains the required
elements 'objectIdentifier' and 'destinationParentIdentifier'.
'destinationParentIdentifier' is the target collection.
</para>
<para>
The function returns &true; on success or an error object.
</para>
<para>
See also <function>hwapi_copy</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
-->