dio-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e41806c30bf6975e452c0d4ce35ab0984c2fa68c Maintainer: chuso Status: ready -->
<!-- Reviewed: no Maintainer: andresdzphp -->

<refentry xml:id="function.dio-open" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dio_open</refname>
  <refpurpose>
   Abre (crea si fuera necesario) un fichero a un nivel más bajo que el permitido por
   flujos de entrada y salida de las bibliotecas en C
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>dio_open</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam><type>int</type><parameter>flags</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
   </methodsynopsis>
  <para>
   <function>dio_open</function> abre un fichero y devuelve su descriptor
   de fichero.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Ruta del fichero a abrir.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       El parámetro <parameter>flags</parameter> es una máscara OR de bits
       compuesta a partir de las siguientes banderas. Estos valores
       <emphasis>tienen</emphasis> que incluir alguno de entre
       <constant>O_RDONLY</constant>, <constant>O_WRONLY</constant>,
       o <constant>O_RDWR</constant>. Además, podría incluir cualquier
       combinación del resto de banderas de la lista.
       <itemizedlist>
        <listitem>
         <para>
          <constant>O_RDONLY</constant> - abre el fichero con acceso de lectura.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_WRONLY</constant> - abre el fichero con acceso de escritura.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_RDWR</constant> - abre el fichero con acceso de lectura y
          de escritura.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_CREAT</constant> - crea el fichero, si no existiera
          ya.
         </para>
        </listitem> 
        <listitem>
         <para>
          <constant>O_EXCL</constant> - si tanto <constant>O_CREAT</constant>
          como <constant>O_EXCL</constant> están habilitados, y el fichero
          existe, <function>dio_open</function> fallará.
         </para>
        </listitem> 
        <listitem>
         <para>
          <constant>O_TRUNC</constant> - si el fichero existe, y está abierto
          con sólo escritura, se truncará a cero.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_APPEND</constant> - las operaciones de escritura añaden los
          datos al final del fichero.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_NONBLOCK</constant> - asigna el modo no bloqueante.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_NOCTTY</constant> - previene que el SO asigne al fichero
          abierto como el terminal controlador del proceso cuando se abra
          un fichero de dispositivo TTY.
         </para>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       Si <parameter>flags</parameter> contiene
       <constant>O_CREAT</constant>, <parameter>mode</parameter> establecerá
       los permisos del ficher (permisos
       de creación). <parameter>mode</parameter> es necesario para un correcto
       funcionamiento cuando <constant>O_CREAT</constant> se especifica en
       <parameter>flags</parameter>, y se ignorará en cualquier otro caso.
      </para>
      <para>
       Los permisos que realmente se asignan al fichero creado se verán
       afectados por el <emphasis>umask</emphasis> del proceso, como
       suele suceder.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Descriptor de fichero o &false; en caso de error.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Abrir un descriptor de fichero</title>
   <programlisting role="php">
<![CDATA[
<?php

$fd = dio_open('/dev/ttyS0', O_RDWR | O_NOCTTY | O_NONBLOCK);

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