<!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>Send action to the service and set value</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gupnp-service-proxy-action-get.html">gupnp_service_proxy_action_get</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gupnp-service-proxy-add-notify.html">gupnp_service_proxy_add_notify</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-proxy-action-set" class="refentry">
<div class="refnamediv">
<h1 class="refname">gupnp_service_proxy_action_set</h1>
<p class="verinfo">(PECL gupnp >= 0.1.0)</p><p class="refpurpose"><span class="refname">gupnp_service_proxy_action_set</span> — <span class="dc-title">Send action to the service and set value</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.gupnp-service-proxy-action-set-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>gupnp_service_proxy_action_set</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$proxy</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$action</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span>
)</div>
<p class="para rdfs-comment">
Send action with parameters to the service exposed by proxy synchronously and set value.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.gupnp-service-proxy-action-set-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">proxy</code></em></span>
<dd>
<p class="para">
A service proxy identifier.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">action</code></em></span>
<dd>
<p class="para">
An action.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">name</code></em></span>
<dd>
<p class="para">
The action name.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">value</code></em></span>
<dd>
<p class="para">
The action value.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">type</code></em></span>
<dd>
<p class="para">
The type of the action. Type can be one of the following values:
<dl>
<dt>
<span class="term"><strong><code>GUPNP_TYPE_BOOLEAN</code></strong></span>
<dd>
<span class="simpara">
Type of the variable is boolean.
</span>
</dd>
</dt>
<dt>
<span class="term"><strong><code>GUPNP_TYPE_INT</code></strong></span>
<dd>
<span class="simpara">
Type of the variable is integer.
</span>
</dd>
</dt>
<dt>
<span class="term"><strong><code>GUPNP_TYPE_LONG</code></strong></span>
<dd>
<span class="simpara">
Type of the variable is long.
</span>
</dd>
</dt>
<dt>
<span class="term"><strong><code>GUPNP_TYPE_DOUBLE</code></strong></span>
<dd>
<span class="simpara">
Type of the variable is double.
</span>
</dd>
</dt>
<dt>
<span class="term"><strong><code>GUPNP_TYPE_FLOAT</code></strong></span>
<dd>
<span class="simpara">
Type of the variable is float.
</span>
</dd>
</dt>
<dt>
<span class="term"><strong><code>GUPNP_TYPE_STRING</code></strong></span>
<dd>
<span class="simpara">
Type of the variable is string.
</span>
</dd>
</dt>
</dl>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gupnp-service-proxy-action-set-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 errors" id="refsect1-function.gupnp-service-proxy-action-set-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Issues E_WARNING with either not correctly defined type of the action or unable to send action.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.gupnp-service-proxy-action-set-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.gupnp-service-proxy-action-get.html" class="function" rel="rdfs-seeAlso">gupnp_service_proxy_action_get()</a> - Send action to the service and get value</span></li>
<li class="member"> <span class="function"><a href="gupnp-service-proxy-send-action.html" class="function" rel="rdfs-seeAlso">gupnp_service_proxy_send_action()</a> - Send action with multiple parameters synchronously</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-proxy-action-get.html">gupnp_service_proxy_action_get</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gupnp-service-proxy-add-notify.html">gupnp_service_proxy_add_notify</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>
