uTools-Manuals/docs/php/gupnp_service_proxy_action_set.html
2019-04-28 19:00:34 +08:00

206 lines
5.3 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 class="docs"><div id="layout">
<div id="layout-content"><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 &gt;= 0.1.0)</p><p class="refpurpose"><span class="refname">gupnp_service_proxy_action_set</span> &mdash; <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">说明</h3>
<div class="methodsynopsis dc-description">
<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>
) : <span class="type">bool</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">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">proxy</code></dt>
<dd>
<p class="para">
A service proxy identifier.
</p>
</dd>
<dt>
<code class="parameter">action</code></dt>
<dd>
<p class="para">
An action.
</p>
</dd>
<dt>
<code class="parameter">name</code></dt>
<dd>
<p class="para">
The action name.
</p>
</dd>
<dt>
<code class="parameter">value</code></dt>
<dd>
<p class="para">
The action value.
</p>
</dd>
<dt>
<code class="parameter">type</code></dt>
<dd>
<p class="para">
The type of the action. Type can be one of the following values:
<dl>
<dt>
<strong><code>GUPNP_TYPE_BOOLEAN</code></strong></dt>
<dd>
<span class="simpara">
Type of the variable is boolean.
</span>
</dd>
<dt>
<strong><code>GUPNP_TYPE_INT</code></strong></dt>
<dd>
<span class="simpara">
Type of the variable is integer.
</span>
</dd>
<dt>
<strong><code>GUPNP_TYPE_LONG</code></strong></dt>
<dd>
<span class="simpara">
Type of the variable is long.
</span>
</dd>
<dt>
<strong><code>GUPNP_TYPE_DOUBLE</code></strong></dt>
<dd>
<span class="simpara">
Type of the variable is double.
</span>
</dd>
<dt>
<strong><code>GUPNP_TYPE_FLOAT</code></strong></dt>
<dd>
<span class="simpara">
Type of the variable is float.
</span>
</dd>
<dt>
<strong><code>GUPNP_TYPE_STRING</code></strong></dt>
<dd>
<span class="simpara">
Type of the variable is string.
</span>
</dd>
</dl>
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gupnp-service-proxy-action-set-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
成功时返回 <strong><code>TRUE</code></strong> 或者在失败时返回 <strong><code>FALSE</code></strong>
</p>
</div>
<div class="refsect1 errors" id="refsect1-function.gupnp-service-proxy-action-set-errors">
<h3 class="title">错误/异常</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">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="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></div></div></body></html>