|
| 1 | +<?xml version="1.0" encoding="utf-8"?> |
| 2 | +<!-- EN-Revision: a4fe8cf4c7712c4af6d2b0dc2e3d7090f53f4e21 Maintainer: leonardolara Status: ready --> |
| 3 | + |
| 4 | +<refentry xml:id="function.eio-fallocate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> |
| 5 | + <refnamediv> |
| 6 | + <refname>eio_fallocate</refname> |
| 7 | + <refpurpose>Permite ao chamador manipular diretamente o espaço alocado |
| 8 | + em disco para um arquivo</refpurpose> |
| 9 | + </refnamediv> |
| 10 | + |
| 11 | + <refsect1 role="description"> |
| 12 | + &reftitle.description; |
| 13 | + <methodsynopsis> |
| 14 | + <type>resource</type><methodname>eio_fallocate</methodname> |
| 15 | + <methodparam><type>mixed</type><parameter>fd</parameter></methodparam> |
| 16 | + <methodparam><type>int</type><parameter>mode</parameter></methodparam> |
| 17 | + <methodparam><type>int</type><parameter>offset</parameter></methodparam> |
| 18 | + <methodparam><type>int</type><parameter>length</parameter></methodparam> |
| 19 | + <methodparam |
| 20 | + choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam> |
| 21 | + <methodparam |
| 22 | + choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam> |
| 23 | + <methodparam |
| 24 | + choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam> |
| 25 | + |
| 26 | + </methodsynopsis> |
| 27 | + |
| 28 | + <para> |
| 29 | + <function>eio_fallocate</function> permite ao chamador manipular diretamente o espaço alocado |
| 30 | + em disco para o arquivo especificado elo descrito de arquivo <parameter>fd</parameter> para o |
| 31 | + intervalo de byte iniciando em <parameter>offset</parameter> e continuando pelo númer de bytes |
| 32 | + informado em <parameter>length</parameter>. |
| 33 | + </para> |
| 34 | + |
| 35 | + <note xmlns="http://docbook.org/ns/docbook"> |
| 36 | + <title>O arquivo deve ser aberto para escrita</title> |
| 37 | + <para><constant>EIO_O_CREAT</constant> deve ser combinado através de uma operação lógica |
| 38 | + <emphasis>OR</emphasis> com <constant>EIO_O_WRONLY</constant> ou |
| 39 | + <constant>EIO_O_RDWR</constant> |
| 40 | + </para> |
| 41 | + </note> |
| 42 | + |
| 43 | + </refsect1> |
| 44 | + |
| 45 | + <refsect1 role="parameters"> |
| 46 | + &reftitle.parameters; |
| 47 | + <variablelist> |
| 48 | + <varlistentry> |
| 49 | + <term><parameter>fd</parameter></term> |
| 50 | + <listitem> |
| 51 | + <para> |
| 52 | + Fluxo, recurso de socket ou descritor numérico de arquivo, por exemplo, retornado por <function>eio_open</function>. |
| 53 | + </para> |
| 54 | + </listitem> |
| 55 | + </varlistentry> |
| 56 | + <varlistentry> |
| 57 | + <term><parameter>mode</parameter></term> |
| 58 | + <listitem> |
| 59 | + <para>Atualmente apenas uma opção de modo é suportada: |
| 60 | + <constant>EIO_FALLOC_FL_KEEP_SIZE</constant> (o mesmo que a constante POSIX |
| 61 | + <constant>FALLOC_FL_KEEP_SIZE</constant>). |
| 62 | + </para> |
| 63 | + </listitem> |
| 64 | + </varlistentry> |
| 65 | + <varlistentry> |
| 66 | + <term><parameter>offset</parameter></term> |
| 67 | + <listitem> |
| 68 | + <para> |
| 69 | + Especifica o início do intervalo de bytes. |
| 70 | + </para> |
| 71 | + </listitem> |
| 72 | + </varlistentry> |
| 73 | + <varlistentry> |
| 74 | + <term><parameter>length</parameter></term> |
| 75 | + <listitem> |
| 76 | + <para> |
| 77 | + Especifica o comprimento do intervalo de bytes. |
| 78 | + </para> |
| 79 | + </listitem> |
| 80 | + </varlistentry> |
| 81 | + <varlistentry> |
| 82 | + <term><parameter>pri</parameter></term> |
| 83 | + <listitem> |
| 84 | + &eio.request.pri.values; |
| 85 | + </listitem> |
| 86 | + </varlistentry> |
| 87 | + <varlistentry> |
| 88 | + <term><parameter>callback</parameter></term> |
| 89 | + <listitem> |
| 90 | + &eio.callback.proto; |
| 91 | + </listitem> |
| 92 | + </varlistentry> |
| 93 | + <varlistentry> |
| 94 | + <term><parameter>data</parameter></term> |
| 95 | + <listitem> |
| 96 | + <para> |
| 97 | + Variável arbitrária passada para <parameter>callback</parameter>. |
| 98 | + </para> |
| 99 | + </listitem> |
| 100 | + </varlistentry> |
| 101 | + </variablelist> |
| 102 | + </refsect1> |
| 103 | + |
| 104 | + <refsect1 role="returnvalues"> |
| 105 | + &reftitle.returnvalues; |
| 106 | + <para> |
| 107 | + <function>eio_fallocate</function> retorna o recurso da requisição em caso de sucesso,&return.falseforfailure;. |
| 108 | + </para> |
| 109 | + </refsect1> |
| 110 | + |
| 111 | +</refentry> |
| 112 | + |
| 113 | +<!-- Keep this comment at the end of the file |
| 114 | +Local variables: |
| 115 | +mode: sgml |
| 116 | +sgml-omittag:t |
| 117 | +sgml-shorttag:t |
| 118 | +sgml-minimize-attributes:nil |
| 119 | +sgml-always-quote-attributes:t |
| 120 | +sgml-indent-step:1 |
| 121 | +sgml-indent-data:t |
| 122 | +indent-tabs-mode:nil |
| 123 | +sgml-parent-document:nil |
| 124 | +sgml-default-dtd-file:"~/.phpdoc/manual.ced" |
| 125 | +sgml-exposed-tags:nil |
| 126 | +sgml-local-catalogs:nil |
| 127 | +sgml-local-ecat-files:nil |
| 128 | +End: |
| 129 | +vim600: syn=xml fen fdm=syntax fdl=2 si |
| 130 | +vim: et tw=78 syn=sgml |
| 131 | +vi: ts=1 sw=1 |
| 132 | +--> |
0 commit comments