shmop-read.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e50e79746736dbdfbabe9bd3566793b3ddf38f58 Maintainer: mumumu Status: ready -->
<refentry xml:id="function.shmop-read" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>shmop_read</refname>
  <refpurpose>共有メモリブロックからデータを読み取る</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>shmop_read</methodname>
   <methodparam><type>Shmop</type><parameter>shmop</parameter></methodparam>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam><type>int</type><parameter>size</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>shmop_read</function> は、共有メモリブロックから文字列を読み取ります。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>shmop</parameter></term>
     <listitem>
      <para>
       <function>shmop_open</function> 関数で作られた、共有メモリブロックの識別子。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       読み取りを始めるオフセット。
       この値は 0 以上、かつ共有メモリセグメントの実際のサイズ以下でなければいけません。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>size</parameter></term>
     <listitem>
      <para>
       読み取るバイト数。
       この値は 0 以上、かつ <parameter>offset</parameter> と <parameter>size</parameter>
       の合計値が、共有メモリセグメントの実際のサイズ以下でなければいけません。
       <literal>0</literal> を指定すると、<code>shmop_size($shmid) - $start</code> バイトを読み取ります。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   読み取ったデータを返します。
   &return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <parameter>offset</parameter> や <parameter>size</parameter> が範囲外の値の場合、
   <classname>ValueError</classname> がスローされます。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       引数 <parameter>shmop</parameter> は、
       <classname>Shmop</classname> クラスのインスタンスを期待するようになりました。
       これより前のバージョンでは、リソースを期待していました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>offset</parameter> や <parameter>size</parameter> が範囲外の値の場合、
       <classname>ValueError</classname> がスローされるようになりました。
       これより前のバージョンでは、<constant>E_WARNING</constant>
       が発生し、&false; を返していました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>共有メモリブロックを読み取る</title>
    <programlisting role="php">
<![CDATA[
<?php
$shm_data = shmop_read($shm_id, 0, 50);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   この例は、共有メモリブロックから50バイトを読み取り、
   データを <literal>$shm_data</literal> に格納します。
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>shmop_write</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->