Files
doc-fr/reference/eio/functions/eio-fallocate.xml
2021-06-12 06:21:36 +01:00

141 lines
4.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a4fe8cf4c7712c4af6d2b0dc2e3d7090f53f4e21 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.eio-fallocate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>eio_fallocate</refname>
<refpurpose>Autorise l'appelant à manipuler directement l'espace disque alloué pour un fichier</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>eio_fallocate</methodname>
<methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
<methodparam
choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
<methodparam
choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
<function>eio_fallocate</function> autorise l'appelant à manipuler directement
l'espace disque alloué pour le fichier spécifié par le descripteur de fichier
<parameter>fd</parameter> pour l'intervalle d'octets commençant à
<parameter>offset</parameter> et se prolongeant sur
<parameter>length</parameter> octets.
</para>
<note xmlns="http://docbook.org/ns/docbook">
<title>Le fichier doit être ouvert en écriture</title>
<para>
La constante <constant>EIO_O_CREAT</constant> doit être un
<emphasis>OU</emphasis> logique avec <constant>EIO_O_WRONLY</constant>, ou
<constant>EIO_O_RDWR</constant>.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
Un flux, une ressource de socket,
ou un descripteur de fichier, i.e. retourné par la fonction
<function>eio_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Actuellement, un seul drapeau est supporté pour le mode :
<constant>EIO_FALLOC_FL_KEEP_SIZE</constant> (identique à la constante
POSIX <constant>FALLOC_FL_KEEP_SIZE</constant>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
Spécifie le début de l'intervalle d'octets.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
Spécifie la longueur de l'intervalle d'octets.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pri</parameter></term>
<listitem>
&eio.request.pri.values;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
&eio.callback.proto;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
Variables arbitraires à passer à la fonction de rappel
<parameter>callback</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>eio_fallocate</function> retourne une ressource de la
requête en cas de succès,&return.falseforfailure;.
</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
-->