Home > PHP > Function > WinCache > wincache_ucache_dec()

wincache_ucache_dec()

wincache_ucache_dec - Decrements the value associated with the key

Syntax

mixed wincache_ucache_dec (string $key, $dec_by, bool &$success)

Arguments

  • key - The key that was used to store the variable in the cache. key is case sensitive.
  • dec_by - The value by which the variable associated with the key will get decremented. If the argument is a floating point number it will be truncated to nearest integer. The variable associated with the key should be of type long, otherwise the function fails and returns FALSE.
  • success - Will be set to TRUEon success and FALSEon failure.

Description

Decrements the value associated with the key by 1 or as specified by dec_by.

Version

PHP PECL wincache >= 1.1.0

Return value

Returns the decremented value on success and FALSEon failure.