mirror of
https://github.com/php/doc-ja.git
synced 2026-03-28 09:02:14 +01:00
140 lines
3.8 KiB
XML
140 lines
3.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 32e694be42ba6e75a8c78483c17a75725937d247 Maintainer: hirokawa Status: ready -->
|
|
<!-- CREDITS: shimooka,mumumu -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fgets">
|
|
<refnamediv>
|
|
<refname>fgets</refname>
|
|
<refpurpose>ファイルポインタから 1 行取得する</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>string</type><type>false</type></type><methodname>fgets</methodname>
|
|
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
|
|
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
ファイルポインタから 1 行取得します。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>stream</parameter></term>
|
|
<listitem>
|
|
&fs.validfp.all;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>length</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
読み出しは、<parameter>length</parameter> - 1
|
|
バイト読み出したか、(戻り値に含まれる)
|
|
改行文字を検出したか、EOF に達したかのいずれかが起こった時点で終了します。
|
|
length が指定されない場合は、行末に達するまで読み続けます。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
<parameter>stream</parameter> で指定したファイルポインタから最大
|
|
<parameter>length</parameter> - 1 バイト読み出し、
|
|
その文字列を返します。ファイルポインタから読み込むデータがもうない場合は
|
|
&false; を返します。
|
|
</para>
|
|
<para>
|
|
エラーが起こった場合、&false; を返します。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>行毎にファイルを読み込む</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$fp = @fopen("/tmp/inputfile.txt", "r");
|
|
|
|
if ($fp) {
|
|
while (($buffer = fgets($fp, 4096)) !== false) {
|
|
echo $buffer, PHP_EOL;
|
|
}
|
|
|
|
if (!feof($fp)) {
|
|
echo "Error: unexpected fgets() fail\n";
|
|
}
|
|
|
|
fclose($fp);
|
|
}
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
¬e.line-endings;
|
|
<note>
|
|
<para>
|
|
C 言語の <function>fgets</function> の動作に慣れている人は、
|
|
<literal>EOF</literal> を返す条件の違いについて注意する必要があります。
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>fgetss</function></member>
|
|
<member><function>fread</function></member>
|
|
<member><function>fgetc</function></member>
|
|
<member><function>stream_get_line</function></member>
|
|
<member><function>fopen</function></member>
|
|
<member><function>popen</function></member>
|
|
<member><function>fsockopen</function></member>
|
|
<member><function>stream_set_timeout</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
|
|
-->
|