php-doc-en/reference/recode/functions/recode-file.xml
2003-12-15 16:55:22 +00:00

66 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/recode.xml, last change in rev 1.2 -->
<refentry id="function.recode-file">
<refnamediv>
<refname>recode_file</refname>
<refpurpose>
Recode from file to file according to recode request
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>. Returns &false;, if unable to
comply, &true; otherwise.
</para>
<para>
This function does not currently process filehandles referencing
remote files (URLs). Both filehandles must refer to local files.
</para>
<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>
</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
-->