<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.wincache-ucache-inc" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>wincache_ucache_inc</refname>
  <refpurpose>
   Increments the value associated with the key
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>wincache_ucache_inc</methodname>
   <methodparam><type>string</type><parameter>key</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>inc_by</parameter><initializer>1</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter role="reference">success</parameter></methodparam>
  </methodsynopsis>
  <para>
   Increments the value associated with the <parameter>key</parameter> by 1 or as specified 
   by <parameter>inc_by</parameter>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       The <parameter>key</parameter> that was used to store the variable in the cache. 
       <parameter>key</parameter> is case sensitive.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>inc_by</parameter></term>
     <listitem>
      <para>
       The value by which the variable associated with the <parameter>key</parameter> will get incremented. 
       If the argument is a floating point number it will be truncated to nearest integer. The variable 
       associated with the <parameter>key</parameter> should be of type <literal>long</literal>, otherwise 
       the function fails and returns &false;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>success</parameter></term>
     <listitem>
      <para>
       Will be set to &true; on success and &false; on failure.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Returns the incremented value on success and &false; on failure.
  </simpara>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Using <function>wincache_ucache_inc</function></title>
    <programlisting role="php">
<![CDATA[
<?php
wincache_ucache_set('counter', 1);
var_dump(wincache_ucache_inc('counter', 2921, $success));
var_dump($success);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
int(2922) 
bool(true)
]]>
    </screen>    
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>wincache_ucache_dec</function></member>
    <member><function>wincache_ucache_cas</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
-->
