bzopen.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f68a84be2a7c67c1bfdc59f2e4719af3c62e1f53 Maintainer: yago Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.bzopen" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>bzopen</refname>
  <refpurpose>Abre un fichero comprimido con bzip2</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>bzopen</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam><type>string</type><parameter>mode</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>bzopen</function> abre un fichero bzip2 (.bz2) para lectura o 
   escritura.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       El nombre del fichero a abrir, o un recurso de flujo existente.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       Similar a la función <function>fopen</function>, solamente 'r' (lectura)
       y 'w' (escritura) están soportados. Todo lo demás hará que bzopen
       devuelva &false;.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Si al abrir el fichero se produce un error, <function>bzopen</function> devolverá &false;, en caso contrario
   devolverá el puntero del nuevo fichero abierto.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>bzopen</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$file = "/tmp/foo.bz2";
$bz = bzopen($file, "r") or die("No se pudo abrir el fichero $file para lectura");

bzclose($bz);

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>bzclose</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
-->