fpassthru.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- $Author$ -->
<!-- EN-Revision: 98f2a733bc07e1c6d8fddb1d865b09fd79bdbea2 Maintainer: dallas Status: ready -->
<!-- CREDITS: lm92, mowangjuanzi -->
<refentry xml:id="function.fpassthru" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fpassthru</refname>
  <refpurpose>输出文件指针处的所有剩余数据</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>fpassthru</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
  </methodsynopsis>
  <para>
   将给定的文件指针从当前的位置读取到 EOF 并把结果写到输出缓冲区。
  </para>
  <para>
   如果已经向文件写入数据，就必须调用 <function>rewind</function>
   来将文件指针指向文件头。
  </para>
  <para>
   如果既不修改文件也不在特定位置检索，只想将文件的内容下载到输出缓冲区，应该使用
   <function>readfile</function>，这样可以省去
   <function>fopen</function> 调用。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      &fs.validfp.all;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   返回从 <parameter>stream</parameter>
   读取并传递到输出的字符数量。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>对二进制文件使用 <function>fpassthru</function></title>
    <programlisting role="php">
<![CDATA[
<?php

// 以二进制格式打开文件
$name = './img/ok.png';
$fp = fopen($name, 'rb');

// 发送合适的报头
header("Content-Type: image/png");
header("Content-Length: " . filesize($name));

// 发送图片并终止脚本
fpassthru($fp);
exit;

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    当在 Windows
    系统中将 <function>fpassthru</function>
    用于二进制文件，要确保在用
    <function>fopen</function>
    打开文件时在 mode 中附加了
    <literal>b</literal> 来将文件以二进制方式打开。
   </para>
   <para>
    鼓励在处理二进制文件时使用
    <literal>b</literal>
    标志，即使系统并不需要，这样可以使脚本的移植性更好。
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>readfile</function></member>
    <member><function>fopen</function></member>
    <member><function>popen</function></member>
    <member><function>fsockopen</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
-->