<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.shmop.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.shmop-read.php',
    1 => 'shmop_read',
    2 => 'Считывает данные из блока разделяемой памяти',
  ),
  'up' => 
  array (
    0 => 'ref.shmop.php',
    1 => 'Разделяемая (shared) память',
  ),
  'prev' => 
  array (
    0 => 'function.shmop-open.php',
    1 => 'shmop_open',
  ),
  'next' => 
  array (
    0 => 'function.shmop-size.php',
    1 => 'shmop_size',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/shmop/functions/shmop-read.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.shmop-read" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">shmop_read</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">shmop_read</span> &mdash; <span class="dc-title">Считывает данные из блока разделяемой памяти</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.shmop-read-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>shmop_read</strong></span>(<span class="methodparam"><span class="type"><a href="class.shmop.php" class="type Shmop">Shmop</a></span> <code class="parameter">$shmop</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$offset</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$size</code></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="simpara">
   Функция <span class="function"><strong>shmop_read()</strong></span> возвращает строковые данные, которые хранятся
   в участке разделяемой памяти.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.shmop-read-parameters">
  <h3 class="title">Список параметров</h3>
  <dl>
   
    <dt><code class="parameter">shmop</code></dt>
    <dd>
     <span class="simpara">
      Ресурс блока памяти, который возвращает функция <span class="function"><a href="function.shmop-open.php" class="function">shmop_open()</a></span>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">offset</code></dt>
    <dd>
     <span class="simpara">
      Смещение, с которого начинается чтение; параметр принимает значение, которое больше или равно нулю
      и меньше или равно фактическому размеру сегмента разделяемой памяти.
     </span>
    </dd>
   
   
    <dt><code class="parameter">size</code></dt>
    <dd>
     <span class="simpara">
      Количество байтов для чтения; параметр принимает только значения, которые больше или равны нулю,
      а сумма <code class="parameter">offset</code> и <code class="parameter">size</code> — меньше
      или равна фактическому размеру сегмента разделяемой памяти. Со значением <code class="literal">0</code>
      функция считывает байты по формуле: <code class="code">shmop_size($shmid) - $start</code>.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.shmop-read-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="simpara">
   Функция возвращает данные, которые считала.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.shmop-read-errors">
  <h3 class="title">Ошибки</h3>
  <p class="simpara">
   Функция выбрасывает ошибку <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span>,
   если в аргументе <code class="parameter">offset</code> или <code class="parameter">size</code>
   передали значение вне допустимого диапазона.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.shmop-read-changelog">
  <h3 class="title">Список изменений</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Версия</th>
      <th>Описание</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       Параметр <code class="parameter">shmop</code> теперь ожидает экземпляр класса <span class="classname"><a href="class.shmop.php" class="classname">Shmop</a></span>; раньше ожидался ресурс (<span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>).
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       Функция выбрасывает ошибку <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span>,
       если в аргументе <code class="parameter">offset</code> или <code class="parameter">size</code>
       передали значение вне допустимого диапазона;
       раньше выдавалась ошибка уровня <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> и функция возвращала значение <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.shmop-read-examples">
  <h3 class="title">Примеры</h3>
  <div class="example" id="example-1">
   <p><strong>Пример #1 Пример считывания данных из участка разделяемой памяти</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><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 /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <p class="simpara">
   В приведённом примере функция считает из блока разделяемой памяти 50 байтов
   и запишет данные в переменную <code class="literal">$shm_data</code>.
  </p>
 </div>

 <div class="refsect1 seealso" id="refsect1-function.shmop-read-seealso">
  <h3 class="title">Смотрите также</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.shmop-write.php" class="function" rel="rdfs-seeAlso">shmop_write()</a> - Запись данных в разделяемую память</span></li>
  </ul>
 </div>

</div><?php manual_footer($setup); ?>