<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Inserts a new object of type anchor</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="hwapi.insert.html">hw_api::insert</a></div> <div class="next" style="text-align: right; float: right;"><a href="hwapi.insertcollection.html">hw_api::insertcollection</a></div> <div class="up"><a href="ref.hwapi.html">Hyperwave API Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="hwapi.insertanchor" class="refentry"> <div class="refnamediv"> <h1 class="refname">hw_api::insertanchor</h1> <p class="verinfo">(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api::insertanchor</span> — <span class="dc-title">Inserts a new object of type anchor</span></p> </div> <div class="refsect1 description" id="refsect1-hwapi.insertanchor-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><span class="type hw_api_object">hw_api_object</span></span> <span class="methodname"><strong>hw_api::insertanchor</strong></span> ( <span class="methodparam"><span class="type">array</span> <code class="parameter">$parameter</code></span> )</div> <p class="para rdfs-comment"> This function is a shortcut for <span class="function"><strong>hwapi_insert()</strong></span>. It inserts an object of type anchor and sets some of the attributes required for an anchor. </p> </div> <div class="refsect1 parameters" id="refsect1-hwapi.insertanchor-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">parameter</code></em></span> <dd> <p class="para"> The parameter array contains the required elements 'object' and 'documentIdentifier' and the optional elements 'destinationIdentifier', 'parameter', 'hint' and 'attributeSelector'. The 'documentIdentifier' specifies the document where the anchor shall be inserted. The target of the anchor is set in 'destinationIdentifier' if it already exists. If the target does not exists the element 'hint' has to be set to the name of object which is supposed to be inserted later. Once it is inserted the anchor target is resolved automatically. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-hwapi.insertanchor-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> </p> </div> <div class="refsect1 seealso" id="refsect1-hwapi.insertanchor-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="hwapi.insert.html" class="xref">hw_api::insert</a></li> <li class="member"><a href="hwapi.insertdocument.html" class="xref">hw_api::insertdocument</a></li> <li class="member"><a href="hwapi.insertcollection.html" class="xref">hw_api::insertcollection</a></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="hwapi.insert.html">hw_api::insert</a></div> <div class="next" style="text-align: right; float: right;"><a href="hwapi.insertcollection.html">hw_api::insertcollection</a></div> <div class="up"><a href="ref.hwapi.html">Hyperwave API Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>