<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Retrieves information about session cache memory usage</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.wincache-scache-info.html">wincache_scache_info</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.wincache-ucache-add.html">wincache_ucache_add</a></div>
<div class="up"><a href="ref.wincache.html">WinCache Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.wincache-scache-meminfo" class="refentry">
<div class="refnamediv">
<h1 class="refname">wincache_scache_meminfo</h1>
<p class="verinfo">(PECL wincache >= 1.1.0)</p><p class="refpurpose"><span class="refname">wincache_scache_meminfo</span> — <span class="dc-title">
Retrieves information about session cache memory usage
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.wincache-scache-meminfo-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>wincache_scache_meminfo</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Retrieves information about memory usage by session cache.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.wincache-scache-meminfo-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Array of meta data about session cache memory usage or <strong><code>FALSE</code></strong> on failure
</p>
<p class="para">
The array returned by this function contains the following elements:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<em>memory_total</em> - amount of memory in bytes allocated for the session cache
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>memory_free</em> - amount of free memory in bytes available for the session cache
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>num_used_blks</em> - number of memory blocks used by the session cache
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>num_free_blks</em> - number of free memory blocks available for the session cache
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>memory_overhead</em> - amount of memory in bytes used for the session cache internal structures
</span>
</li>
</ul>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.wincache-scache-meminfo-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-568">
<p><strong>Example #1 A <span class="function"><strong>wincache_scache_meminfo()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<pre><br /><span style="color: #0000BB"><?php<br />print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">wincache_scache_meminfo</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?><br /></span></pre></span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[memory_total] => 5242880
[memory_free] => 5215056
[num_used_blks] => 6
[num_free_blks] => 3
[memory_overhead] => 176
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.wincache-scache-meminfo-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.wincache-fcache-fileinfo.html" class="function" rel="rdfs-seeAlso">wincache_fcache_fileinfo()</a> - Retrieves information about files cached in the file cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-fcache-meminfo.html" class="function" rel="rdfs-seeAlso">wincache_fcache_meminfo()</a> - Retrieves information about file cache memory usage</span></li>
<li class="member"> <span class="function"><a href="function.wincache-ocache-fileinfo.html" class="function" rel="rdfs-seeAlso">wincache_ocache_fileinfo()</a> - Retrieves information about files cached in the opcode cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-rplist-fileinfo.html" class="function" rel="rdfs-seeAlso">wincache_rplist_fileinfo()</a> - Retrieves information about resolve file path cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-rplist-meminfo.html" class="function" rel="rdfs-seeAlso">wincache_rplist_meminfo()</a> - Retrieves information about memory usage by the resolve file path cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-refresh-if-changed.html" class="function" rel="rdfs-seeAlso">wincache_refresh_if_changed()</a> - Refreshes the cache entries for the cached files</span></li>
<li class="member"> <span class="function"><a href="function.wincache-ucache-info.html" class="function" rel="rdfs-seeAlso">wincache_ucache_info()</a> - Retrieves information about data stored in the user cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-scache-info.html" class="function" rel="rdfs-seeAlso">wincache_scache_info()</a> - Retrieves information about files cached in the session cache</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.wincache-scache-info.html">wincache_scache_info</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.wincache-ucache-add.html">wincache_ucache_add</a></div>
<div class="up"><a href="ref.wincache.html">WinCache Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
