<!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>Returns the size of the named shared memory</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="syncsharedmemory.read.html">SyncSharedMemory::read</a></div> <div class="next" style="text-align: right; float: right;"><a href="syncsharedmemory.write.html">SyncSharedMemory::write</a></div> <div class="up"><a href="class.syncsharedmemory.html">SyncSharedMemory</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="syncsharedmemory.size" class="refentry"> <div class="refnamediv"> <h1 class="refname">SyncSharedMemory::size</h1> <p class="verinfo">(PECL sync >= 1.1.0)</p><p class="refpurpose"><span class="refname">SyncSharedMemory::size</span> — <span class="dc-title">Returns the size of the named shared memory</span></p> </div> <div class="refsect1 description" id="refsect1-syncsharedmemory.size-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>SyncSharedMemory::size</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> Retrieves the shared memory size of a SyncSharedMemory object. </p> </div> <div class="refsect1 parameters" id="refsect1-syncsharedmemory.size-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-syncsharedmemory.size-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> An integer containing the size of the shared memory. This will be the same size that was passed to the constructor. </p> </div> <div class="refsect1 examples" id="refsect1-syncsharedmemory.size-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-4609"> <p><strong>Example #1 <span class="function"><strong>SyncSharedMemory::size()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$mem </span><span style="color: #007700">= new </span><span style="color: #0000BB">SyncSharedMemory</span><span style="color: #007700">(</span><span style="color: #DD0000">"AppReportName"</span><span style="color: #007700">, </span><span style="color: #0000BB">1024</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$mem</span><span style="color: #007700">-></span><span style="color: #0000BB">size</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> int(1024) </pre></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-syncsharedmemory.size-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"><span class="methodname"><a href="syncsharedmemory.construct.html" class="methodname" rel="rdfs-seeAlso">SyncSharedMemory::__construct()</a> - Constructs a new SyncSharedMemory object</span></li> <li class="member"><span class="methodname"><a href="syncsharedmemory.write.html" class="methodname" rel="rdfs-seeAlso">SyncSharedMemory::write()</a> - Copy data to named shared memory</span></li> <li class="member"><span class="methodname"><a href="syncsharedmemory.read.html" class="methodname" rel="rdfs-seeAlso">SyncSharedMemory::read()</a> - Copy data from named shared memory</span></li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="syncsharedmemory.read.html">SyncSharedMemory::read</a></div> <div class="next" style="text-align: right; float: right;"><a href="syncsharedmemory.write.html">SyncSharedMemory::write</a></div> <div class="up"><a href="class.syncsharedmemory.html">SyncSharedMemory</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>