mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
065dd47a92
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322131 c90b9560-bf6c-de11-be94-00142212c4b1
109 lines
3.2 KiB
XML
109 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="gupnp-service-proxy-send-action" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>gupnp_service_proxy_send_action</refname>
|
|
<refpurpose>Send action with multiple parameters synchronously</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>gupnp_service_proxy_send_action</methodname>
|
|
<methodparam><type>resource</type><parameter>proxy</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>action</parameter></methodparam>
|
|
<methodparam><type>array</type><parameter>in_params</parameter></methodparam>
|
|
<methodparam><type>array</type><parameter>out_params</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Send action action with parameters <parameter>in_params</parameter> to the service exposed by proxy synchronously and return <parameter>out_params</parameter> with values or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>proxy</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A service proxy identifier.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>action</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An action.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>in_params</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An array of in parameters. Each entry in <parameter>in_params</parameter> is supposed to an array containing name, type and value of the parameters.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>out_params</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An array of out parameters. Each entry in <parameter>out_params</parameter> is supposed to an array containing name and type of the parameters.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Return <parameter>out_params</parameter> array with values or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
Issues E_WARNING with either not correctly defined <parameter>in_params</parameter> and <parameter>out_params</parameter> or unable to send action.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>gupnp_service_proxy_action_get</function></member>
|
|
<member><function>gupnp_service_proxy_action_set</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|