dio-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 32040dd7e5d98c136502134110681f80443dd000 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.dio-open" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>dio_open</refname>
  <refpurpose>
   Открывает файл (по необходимости создаёт) на более низком уровне нежели
   потоковые функции ввода/вывода языка 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> открывает файл и возвращает его дескриптор.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Путь открываемого файла.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Параметр <parameter>flags</parameter> задаётся побитовой
       комбинацией констант. Он <emphasis>должен</emphasis> включать одну из констант
       <constant>O_RDONLY</constant>, <constant>O_WRONLY</constant>
       или <constant>O_RDWR</constant>. Дополнительно он может
       содержать другие константы.
       <itemizedlist>
        <listitem>
         <para>
          <constant>O_RDONLY</constant> - открыть файл на чтение.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_WRONLY</constant> - открыть файл на запись.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_RDWR</constant> - открыть файл на чтение и запись.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_CREAT</constant> - создать файл, если его не существует.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_EXCL</constant> - если заданы и <constant>O_CREAT</constant>
          и <constant>O_EXCL</constant> и файл существует, то
          <function>dio_open</function> завершится с ошибкой.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_TRUNC</constant> - если файл существует и был открыт на запись, то
          он будет обрезан до нулевой длины.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_APPEND</constant> - операции записи будут происходить в конец файла.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_NONBLOCK</constant> - установить неблокирующий режим.
         </para>
        </listitem>
        <listitem>
         <para>
          <constant>O_NOCTTY</constant> - запрещает операционной системе
          считать открытый файл за терминал контроля процесса, если был открыт
          файл устройства TTY.
         </para>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       Если <parameter>flags</parameter> содержит
       <constant>O_CREAT</constant>, <parameter>mode</parameter> установит
       разрешения для файла (creation permissions). <parameter>mode</parameter>
       требуется для корректной работы в случае указания <constant>O_CREAT</constant>
       в <parameter>flags</parameter> и в других случаях будет проигнорирован.
      </para>
      <para>
       Актуальные разрешения, которые будут присвоены созданному файлу, будут
       зависеть от настройки <emphasis>umask</emphasis> процесса, как обычно.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Файловый дескриптор или &false; в случае возникновения ошибки.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Открытие файлового дескриптора</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
-->