<?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.sem-get.php',
    1 => 'sem_get',
    2 => 'セマフォ ID を得る',
  ),
  'up' => 
  array (
    0 => 'ref.sem.php',
    1 => 'セマフォ関数',
  ),
  'prev' => 
  array (
    0 => 'function.sem-acquire.php',
    1 => 'sem_acquire',
  ),
  'next' => 
  array (
    0 => 'function.sem-release.php',
    1 => 'sem_release',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/sem/functions/sem-get.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.sem-get" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">sem_get</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">sem_get</span> &mdash; <span class="dc-title">セマフォ ID を得る</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.sem-get-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>sem_get</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$key</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$max_acquire</code><span class="initializer"> = 1</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<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>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$auto_release</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong></span></span><br>): <span class="type"><span class="type"><a href="class.sysvsemaphore.php" class="type SysvSemaphore">SysvSemaphore</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>sem_get()</strong></span> は、
   System V セマフォを指定したキーでアクセスするために使用可能な
   ID を返します。
  </p>
  <p class="simpara">
   同じキーで <span class="function"><strong>sem_get()</strong></span> を 2 度コールした場合、
   別のセマフォ ID が返されます。
   しかし、どちらの ID も同じそのセマフォをアクセスします。
  </p>
  <p class="simpara">
   <code class="parameter">key</code> に <code class="literal">0</code> を指定すると、
   <span class="function"><strong>sem_get()</strong></span> が呼び出される度に新しい非公開のセマフォが作られます。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.sem-get-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">key</code></dt>
    <dd>
     <span class="simpara">
     </span>
    </dd>
   
   
    <dt><code class="parameter">max_acquire</code></dt>
    <dd>
     <span class="simpara">
      同時にセマフォを得ることが可能なプロセス数を
      <code class="parameter">max_acquire</code> にセットします。
     </span>
    </dd>
   
   
    <dt><code class="parameter">permissions</code></dt>
    <dd>
     <span class="simpara">
      セマフォのパーミッション。
      実際には、この値はプロセスが現在そのセマフォに付随している
      唯一のプロセスであることがわかった場合にのみセットされます。
     </span>
    </dd>
   
   
    <dt><code class="parameter">auto_release</code></dt>
    <dd>
     <span class="simpara">
      リクエストの終了時に自動的にセマフォを開放するかどうかを指定します。
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.sem-get-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="simpara">
   成功した場合に正のセマフォ ID、エラー時には <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


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

     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">auto_release</code> の型が
       <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> から <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> に変更されました
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 notes" id="refsect1-function.sem-get-notes">
  <h3 class="title">注意</h3>
  <div class="warning"><strong class="warning">警告</strong>
   <p class="simpara">
    PHP 以外のところで作られたセマフォに <span class="function"><strong>sem_get()</strong></span> でアクセスするときには、
    3 つのセマフォのセットとして作ったものでなければいけないことに注意しましょう
    (たとえば、C の <code class="literal">semget()</code> 関数で作るなら、<code class="literal">nsems</code> に 3 を指定します)。
    そうしないと、PHP からそのセマフォにアクセスできなくなります。
   </p>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.sem-get-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.sem-acquire.php" class="function" rel="rdfs-seeAlso">sem_acquire()</a> - セマフォを得る</span></li>
   <li><span class="function"><a href="function.sem-release.php" class="function" rel="rdfs-seeAlso">sem_release()</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); ?>