cvs: /phpdoc/functions recode.sgml

kk Sun Nov 21 18:57:02 1999 EDT Modified files: /phpdoc/functions recode.sgml Log: Added documentation for function recode_file(). Index: phpdoc/functions/recode.sgml diff -u phpdoc/functions/recode.sgml:1.1 phpdoc/functions/recode.sgml:1.2 --- phpdoc/functions/recode.sgml:1.1 Sun Nov 21 18:01:36 1999 +++ phpdoc/functions/recode.sgml Sun Nov 21 18:57:01 1999 @@ -38,8 +38,32 @@ FALSE, if unable to comply, TRUE otherwise.</para> <para> A simple recode request may be &quot;lat1..iso646-de&quot;. - See also the GNU Recode documenation of your installation + See also the GNU Recode documentation of your installation for detailed instructions about recode requests. + </para> + </refsect1> + </refentry> + + <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> + <funcsynopsis> + <funcdef>bool <function>recode_file</function></funcdef> + <paramdef>int <parameter>input</parameter></paramdef> + <paramdef>int <parameter>output</parameter></paramdef> + </funcsynopsis> + <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 request <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> </refsect1> </refentry>