<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.recode-file" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>recode_file</refname>
  <refpurpose>Recode from file to file according to recode request</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>recode_file</methodname>
   <methodparam><type>string</type><parameter>request</parameter></methodparam>
   <methodparam><type>resource</type><parameter>input</parameter></methodparam>
   <methodparam><type>resource</type><parameter>output</parameter></methodparam>
  </methodsynopsis>
  <para>
   Recode the file referenced by file handle
   <parameter>input</parameter> into the file referenced by file
   handle <parameter>output</parameter> according to the recode
   <parameter>request</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>request</parameter></term>
     <listitem>
      <para>
       The desired recode request type
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>input</parameter></term>
     <listitem>
      <para>
       A local file handle <type>resource</type> for 
       the <parameter>input</parameter>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>output</parameter></term>
     <listitem>
      <para>
       A local file handle <type>resource</type> for 
       the <parameter>output</parameter>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &false;, if unable to comply, &true; otherwise.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example> 
   <title>Basic <function>recode_file</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$input = fopen('input.txt', 'r');
$output = fopen('output.txt', 'w');
recode_file("us..flat", $input, $output);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <para>
   This function does not currently process file handles referencing
   remote files (URLs). Both file handles must refer to local files.
  </para>
 </refsect1>

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