<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.stream.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.stream-get-line.php',
    1 => 'stream_get_line',
    2 => '指定されたデリミタの位置までのデータを一行分としてストリームから読み込む',
  ),
  'up' => 
  array (
    0 => 'ref.stream.php',
    1 => 'ストリーム 関数',
  ),
  'prev' => 
  array (
    0 => 'function.stream-get-filters.php',
    1 => 'stream_get_filters',
  ),
  'next' => 
  array (
    0 => 'function.stream-get-meta-data.php',
    1 => 'stream_get_meta_data',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/stream/functions/stream-get-line.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.stream-get-line" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">stream_get_line</h1>
  <p class="verinfo">(PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">stream_get_line</span> &mdash; <span class="dc-title">指定されたデリミタの位置までのデータを一行分としてストリームから読み込む</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.stream-get-line-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>stream_get_line</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$stream</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$length</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$ending</code><span class="initializer"> = &quot;&quot;</span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   指定したハンドルから一行取得します。
  </p>
  <p class="para">
   読み込みは、<code class="parameter">length</code> バイト読まれたか、
   <code class="parameter">ending</code>
   で指定された空でない文字列がストリームに見つかったか
   (この文字列は返値に <em>含まれません</em>)、あるいは
   <abbr title="End Of File">EOF</abbr> に達したとき、のうち一番最初に遭遇したところで停止します。
  </p>
  <p class="para">
   この関数は <span class="function"><a href="function.fgets.php" class="function">fgets()</a></span> とほとんど同一ですが、
   \n や \r 、\r\n といった一般的な文字列以外を行末を示すデリミタ
   として指定できる点で、またデリミタ自体を返値に <em>含まない</em>
   点で異なります。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.stream-get-line-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">stream</code></dt>
     <dd>
      <p class="para">
       有効なファイルハンドル。
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       ハンドルから読み込む最大バイト数。
       負の値はサポートされていません。
       ゼロ(<code class="literal">0</code>) を指定すると、
       ソケットのデフォルトのチャンクサイズ
       つまり、<code class="literal">8192</code> を使います。
      </p>
     </dd>
    
    
     <dt><code class="parameter">ending</code></dt>
     <dd>
      <p class="para">
       オプションのデリミタ文字列。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.stream-get-line-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   最大 <code class="parameter">length</code> バイトの、
   <code class="parameter">stream</code> で指定されたファイルから読み込んだデータを返します。
   失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します
  </p>
 </div>

  
 <div class="refsect1 seealso" id="refsect1-function.stream-get-line-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.fread.php" class="function" rel="rdfs-seeAlso">fread()</a> - バイナリセーフなファイルの読み込み</span></li>
   <li><span class="function"><a href="function.fgets.php" class="function" rel="rdfs-seeAlso">fgets()</a> - ファイルポインタから 1 行取得する</span></li>
   <li><span class="function"><a href="function.fgetc.php" class="function" rel="rdfs-seeAlso">fgetc()</a> - ファイルポインタから1文字取り出す</span></li>
  </ul>
 </div>


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