<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.zlib.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.gzgets.php',
    1 => 'gzgets',
    2 => 'ファイルポインタから 1 行を得る',
  ),
  'up' => 
  array (
    0 => 'ref.zlib.php',
    1 => 'Zlib 関数',
  ),
  'prev' => 
  array (
    0 => 'function.gzgetc.php',
    1 => 'gzgetc',
  ),
  'next' => 
  array (
    0 => 'function.gzgetss.php',
    1 => 'gzgetss',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/zlib/functions/gzgets.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.gzgets" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">gzgets</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">gzgets</span> &mdash; <span class="dc-title">ファイルポインタから 1 行を得る</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.gzgets-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>gzgets</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"><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">$length</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></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">
   与えられたファイルポインタから最大 length - 1 バイトの文字を読み込み、
   これを含む (非圧縮の) 文字列を返します。
   length - 1 バイトを読み込むか、改行または EOF になった場合、
   (どれかが最初にきた時点で) 読み込みを終了します。
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.gzgets-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">stream</code></dt>
     <dd>
      <p class="para">
       gz ファイルポインタを指定します。
       これは有効なファイルポインタであり、かつ、
       <span class="function"><a href="function.gzopen.php" class="function">gzopen()</a></span>
       によりオープンできたファイルを指している必要があります。
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       取得するデータ長を指定します。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.gzgets-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   非圧縮の文字列、もしくはエラー時に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.gzgets-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">length</code> は、nullable になりました。
       これより前のバージョンでは、
       デフォルトは <code class="literal">1024</code> でした。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.gzgets-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>gzgets()</strong></span> の例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$handle </span><span style="color: #007700">= </span><span style="color: #0000BB">gzopen</span><span style="color: #007700">(</span><span style="color: #DD0000">'somefile.gz'</span><span style="color: #007700">, </span><span style="color: #DD0000">'r'</span><span style="color: #007700">);<br />while (!</span><span style="color: #0000BB">gzeof</span><span style="color: #007700">(</span><span style="color: #0000BB">$handle</span><span style="color: #007700">)) {<br />   </span><span style="color: #0000BB">$buffer </span><span style="color: #007700">= </span><span style="color: #0000BB">gzgets</span><span style="color: #007700">(</span><span style="color: #0000BB">$handle</span><span style="color: #007700">, </span><span style="color: #0000BB">4096</span><span style="color: #007700">);<br />   echo </span><span style="color: #0000BB">$buffer</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">gzclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$handle</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>

 <div class="refsect1 seealso" id="refsect1-function.gzgets-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.gzopen.php" class="function" rel="rdfs-seeAlso">gzopen()</a> - gz ファイルを開く</span></li>
    <li><span class="function"><a href="function.gzgetc.php" class="function" rel="rdfs-seeAlso">gzgetc()</a> - gz ファイルへのポインタから文字を得る</span></li>
    <li><span class="function"><a href="function.gzwrite.php" class="function" rel="rdfs-seeAlso">gzwrite()</a> - バイナリセーフな gz ファイル書き込み</span></li>
   </ul>
  </p>
 </div>

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