<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.wincache-ucache-cas" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>wincache_ucache_cas</refname>
  <refpurpose>
   Compares the variable with old value and assigns new value to it
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>wincache_ucache_cas</methodname>
   <methodparam><type>string</type><parameter>key</parameter></methodparam>
   <methodparam><type>int</type><parameter>old_value</parameter></methodparam>
   <methodparam><type>int</type><parameter>new_value</parameter></methodparam>
  </methodsynopsis>
  <para>
   Compares the variable associated with the <parameter>key</parameter> with <parameter>old_value</parameter> 
   and if it matches then assigns the <parameter>new_value</parameter> to it.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       The <parameter>key</parameter> that is used to store the variable in the cache. 
       <parameter>key</parameter> is case sensitive.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>old_value</parameter></term>
     <listitem>
      <para>
       Old value of the variable pointed by <parameter>key</parameter> in the user cache. 
       The value should be of type <literal>long</literal>, otherwise the function returns 
       &false;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>new_value</parameter></term>
     <listitem>
      <para>
       New value which will get assigned to variable pointer by <parameter>key</parameter> if a 
       match is found. The value should be of type <literal>long</literal>, otherwise 
       the function returns &false;.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Using <function>wincache_ucache_cas</function></title>
    <programlisting role="php">
<![CDATA[
<?php
wincache_ucache_set('counter', 2922);
var_dump(wincache_ucache_cas('counter', 2922, 1));
var_dump(wincache_ucache_get('counter'));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
bool(true) 
int(1)
]]>
    </screen>    
   </example>
  </para>
 </refsect1>

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