dio-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e41806c30bf6975e452c0d4ce35ab0984c2fa68c Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<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> パラメータには、
       以下のフラグの組み合わせを指定します。
       この値は、<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> でファイルのモード
       (作成許可) を指定します。<constant>O_CREAT</constant>
       が <parameter>flags</parameter> に指定されている場合には <parameter>mode</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
-->