<!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>Return error code</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gupnp-service-action-get.html">gupnp_service_action_get</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gupnp-service-action-return.html">gupnp_service_action_return</a></div>
<div class="up"><a href="ref.gupnp.html">Gupnp Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.gupnp-service-action-return-error" class="refentry">
<div class="refnamediv">
<h1 class="refname">gupnp_service_action_return_error</h1>
<p class="verinfo">(PECL gupnp >= 0.1.0)</p><p class="refpurpose"><span class="refname">gupnp_service_action_return_error</span> — <span class="dc-title">Return error code</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.gupnp-service-action-return-error-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>gupnp_service_action_return_error</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$action</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$error_code</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$error_description</code></span>
] )</div>
<p class="para rdfs-comment">
Return error code.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.gupnp-service-action-return-error-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">action</code></em></span>
<dd>
<p class="para">
A service action identifier.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">error_code</code></em></span>
<dd>
<p class="para">
The error code. Signal can be one of the following values or user defined:
<dl>
<dt>
<span class="term"><strong><code>GUPNP_CONTROL_ERROR_INVALID_ACTION</code></strong></span>
<dd>
<span class="simpara">
The action name was invalid.
</span>
</dd>
</dt>
<dt>
<span class="term"><strong><code>GUPNP_CONTROL_ERROR_INVALID_ARGS</code></strong></span>
<dd>
<span class="simpara">
The action arguments were invalid.
</span>
</dd>
</dt>
<dt>
<span class="term"><strong><code>GUPNP_CONTROL_ERROR_OUT_OF_SYNC</code></strong></span>
<dd>
<span class="simpara">
Out of sync (deprecated).
</span>
</dd>
</dt>
<dt>
<span class="term"><strong><code>GUPNP_CONTROL_ERROR_ACTION_FAILED</code></strong></span>
<dd>
<span class="simpara">
The action failed.
</span>
</dd>
</dt>
</dl>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">error_description</code></em></span>
<dd>
<p class="para">
The error description.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gupnp-service-action-return-error-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.gupnp-service-action-return-error-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.gupnp-service-action-return.html" class="function" rel="rdfs-seeAlso">gupnp_service_action_return()</a> - Return successfully</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gupnp-service-action-get.html">gupnp_service_action_get</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gupnp-service-action-return.html">gupnp_service_action_return</a></div>
<div class="up"><a href="ref.gupnp.html">Gupnp Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
