<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sem.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.shm-attach.php',
    1 => 'shm_attach',
    2 => '共有メモリセグメントを作成またはオープンする',
  ),
  'up' => 
  array (
    0 => 'ref.sem.php',
    1 => 'セマフォ関数',
  ),
  'prev' => 
  array (
    0 => 'function.sem-remove.php',
    1 => 'sem_remove',
  ),
  'next' => 
  array (
    0 => 'function.shm-detach.php',
    1 => 'shm_detach',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/sem/functions/shm-attach.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.shm-attach" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">shm_attach</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">shm_attach</span> &mdash; <span class="dc-title">共有メモリセグメントを作成またはオープンする</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.shm-attach-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>shm_attach</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$key</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$size</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$permissions</code><span class="initializer"> = 0666</span></span>): <span class="type"><span class="type"><a href="class.sysvsharedmemory.php" class="type SysvSharedMemory">SysvSharedMemory</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   <span class="function"><strong>shm_attach()</strong></span> は ID を返します。
   これは、指定されたキー <code class="parameter">key</code>
   で System V 共有メモリにアクセスする際に使用することが可能です。
   最初のコールの際に、サイズが <code class="parameter">size</code>、
   オプションのパーミッション <code class="parameter">permissions</code>
   を指定した共有メモリセグメントを作成します。
  </p>
  <p class="simpara">
   同じ <code class="parameter">key</code> で
   <span class="function"><strong>shm_attach()</strong></span> を 2 回コールした場合は
   別の <span class="classname"><a href="class.sysvsharedmemory.php" class="classname">SysvSharedMemory</a></span> インスタンスが返されますが、
   両方のインスタンスは同じ共有メモリをアクセスします。
   <code class="parameter">size</code> および
   <code class="parameter">permissions</code> は無視されます。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.shm-attach-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">key</code></dt>
    <dd>
     <span class="simpara">
      共有メモリセグメント ID を表す数値。
     </span>
    </dd>
   
   
    <dt><code class="parameter">size</code></dt>
    <dd>
     <span class="simpara">
      メモリのサイズ。省略した場合のデフォルトは <var class="filename">php.ini</var> の
      <code class="literal">sysvshm.init_mem</code>、あるいは 10000
      バイトとなります。
     </span>
    </dd>
   
   
    <dt><code class="parameter">permissions</code></dt>
    <dd>
     <span class="simpara">
      オプションのパーミッション設定。デフォルトは 0666 です。
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.shm-attach-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="simpara">
   成功時には、<span class="classname"><a href="class.sysvsharedmemory.php" class="classname">SysvSharedMemory</a></span> クラスのインスタンスを返します。
   失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.shm-attach-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>
       成功時に、この関数は <span class="classname"><a href="class.sysvsharedmemory.php" class="classname">SysvSharedMemory</a></span> クラスのインスタンスを返すようになりました。
       これより前のバージョンでは、リソースが返されていました。
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">size</code> は、nullable になりました。
      </td>
     </tr>

    </tbody>
   
  </table>

  </div>

 <div class="refsect1 seealso" id="refsect1-function.shm-attach-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.shm-detach.php" class="function" rel="rdfs-seeAlso">shm_detach()</a> - 共有メモリセグメントへの接続を閉じる</span></li>
   <li><span class="function"><a href="function.ftok.php" class="function" rel="rdfs-seeAlso">ftok()</a> - パス名とプロジェクト ID を、System V IPC キーに変換する</span></li>
  </ul>
 </div>


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