<!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 document</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="hwapi.insertcollection.html">hw_api::insertcollection</a></div>
<div class="next" style="text-align: right; float: right;"><a href="hwapi.link.html">hw_api::link</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.insertdocument" class="refentry">
<div class="refnamediv">
<h1 class="refname">hw_api::insertdocument</h1>
<p class="verinfo">(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api::insertdocument</span> — <span class="dc-title">Inserts a new object of type document</span></p>
</div>
<div class="refsect1 description" id="refsect1-hwapi.insertdocument-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::insertdocument</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 with content and sets some of the attributes required
for a document.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-hwapi.insertdocument-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',
'parentIdentifier' and 'content' and the optional elements 'mode',
'parameter' and 'attributeSelector'.
</p>
<p class="para">
See <span class="function"><strong>hwapi_insert()</strong></span> for the meaning of each element.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-hwapi.insertdocument-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
</p>
</div>
<div class="refsect1 seealso" id="refsect1-hwapi.insertdocument-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.insertcollection.html" class="xref">hw_api::insertcollection</a></li>
<li class="member"><a href="hwapi.insertanchor.html" class="xref">hw_api::insertanchor</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.insertcollection.html">hw_api::insertcollection</a></div>
<div class="next" style="text-align: right; float: right;"><a href="hwapi.link.html">hw_api::link</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>
