<!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>Read data from shared memory block</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.shmop-open.html">shmop_open</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.shmop-size.html">shmop_size</a></div>
<div class="up"><a href="ref.shmop.html">Shared Memory Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.shmop-read" class="refentry">
<div class="refnamediv">
<h1 class="refname">shmop_read</h1>
<p class="verinfo">(PHP 4 >= 4.0.4, PHP 5)</p><p class="refpurpose"><span class="refname">shmop_read</span> — <span class="dc-title">Read data from shared memory block</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.shmop-read-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>shmop_read</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$shmid</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$start</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$count</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>shmop_read()</strong></span> will read a string from shared memory block.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.shmop-read-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">shmid</code></em></span>
<dd>
<p class="para">
The shared memory block identifier created by
<span class="function"><a href="function.shmop-open.html" class="function">shmop_open()</a></span>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">start</code></em></span>
<dd>
<p class="para">
Offset from which to start reading
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">count</code></em></span>
<dd>
<p class="para">
The number of bytes to read
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.shmop-read-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the data or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.shmop-read-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3726">
<p><strong>Example #1 Reading shared memory block</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$shm_data </span><span style="color: #007700">= </span><span style="color: #0000BB">shmop_read</span><span style="color: #007700">(</span><span style="color: #0000BB">$shm_id</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">50</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
This example will read 50 bytes from shared memory block and place the data
inside <em>$shm_data</em>.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.shmop-read-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.shmop-write.html" class="function" rel="rdfs-seeAlso">shmop_write()</a> - Write data into shared memory block</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.shmop-open.html">shmop_open</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.shmop-size.html">shmop_size</a></div>
<div class="up"><a href="ref.shmop.html">Shared Memory Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
