php-doc-en/reference/gupnp/functions/gupnp-service-proxy-action-set.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.gupnp-service-proxy-action-set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>gupnp_service_proxy_action_set</refname>
  <refpurpose>Send action to the service and set value</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>gupnp_service_proxy_action_set</methodname>
   <methodparam><type>resource</type><parameter>proxy</parameter></methodparam>
   <methodparam><type>string</type><parameter>action</parameter></methodparam>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
   <methodparam><type>int</type><parameter>type</parameter></methodparam>
  </methodsynopsis>
  <para>
   Send action with parameters to the service exposed by proxy synchronously and set value.
  </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>name</parameter></term>
     <listitem>
      <para>
       The action name.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       The action value.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       The type of the action. Type can be one of the following values:
       <variablelist>
        <varlistentry>
         <term><constant>GUPNP_TYPE_BOOLEAN</constant></term>
         <listitem>
          <simpara>
           Type of the variable is boolean.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><constant>GUPNP_TYPE_INT</constant></term>
         <listitem>
          <simpara>
           Type of the variable is integer.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><constant>GUPNP_TYPE_LONG</constant></term>
         <listitem>
          <simpara>
           Type of the variable is long.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><constant>GUPNP_TYPE_DOUBLE</constant></term>
         <listitem>
          <simpara>
           Type of the variable is double.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><constant>GUPNP_TYPE_FLOAT</constant></term>
         <listitem>
          <simpara>
           Type of the variable is float.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><constant>GUPNP_TYPE_STRING</constant></term>
         <listitem>
          <simpara>
           Type of the variable is string.
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Issues E_WARNING with either not correctly defined type of the action 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_send_action</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
-->