Files
doc-fr/reference/zlib/functions/gzwrite.xml
Sergey Panteleev 3eea870a26 Updated to en-revision (#64)
php/doc-en@49d4fb5 - fixed English typos, and added space to "... example"
php/doc-en@0d5b019 - removed ; in English version
php/doc-en@e83ad8e - linux to Linux. French version already has the right variant
php/doc-en@42d9fe8 - fixed English typos
php/doc-en@eedb233 - fixed English typos
2021-07-30 11:10:10 +02:00

145 lines
3.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9d2b858bca85edbeebb83f05a1cd2e87cf90127d Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.gzwrite" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>gzwrite</refname>
<refpurpose>Écrit dans un fichier compressé gzip</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>gzwrite</methodname>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>gzwrite</function> écrit le contenu de la chaîne
<parameter>data</parameter> dans le fichier compressé
<parameter>zp</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
Le pointeur de fichier. Il doit être valide et doit pointer vers un
fichier ouvert avec succès grâce à la fonction <function>gzopen</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
La chaîne à écrire.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
Le nombre d'octets décompressés à écrire. Si fournie, l'écriture
s'arrêtera après <parameter>length</parameter> (décompressé) octets écrits
ou si la fin de la chaîne <parameter>data</parameter> est atteinte ;
celui qui survient le premier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne le nombre d'octets (décompressés) écrits dans le flux gz
donné, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>length</parameter> est désormais nullable; auparavant la valeur
par défaut était <literal>0</literal>.
</entry>
</row>
<row>
<entry>7.4.0</entry>
<entry>
Cette fonction retourne désormais &false; en cas d'échec; auparavant
<literal>0</literal> était retourné.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>gzwrite</function></title>
<programlisting role="php">
<![CDATA[
<?php
$string = 'Quelques informations à compresser';
$gz = gzopen('somefile.gz','w9');
gzwrite($gz, $string);
gzclose($gz);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>gzread</function></member>
<member><function>gzopen</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
-->