view docs/ccguide/open.refentry @ 3115:460fdd304adf

term_mc6850: Include the matching IT.xxx symbols in the comments
author Neal Crook <foofoobedoo@gmail.com>
date Sat, 17 Oct 2015 21:21:11 +0100
parents 42b2c775f05f
children
line wrap: on
line source

<refentry id="open">
<refnamediv>
<refname>Open</refname>
<refpurpose>open a file for read/write access</refpurpose>
</refnamediv>

<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
  <funcdef><function>open</function></funcdef>
  <paramdef>char *<parameter>fname</parameter></paramdef>
  <paramdef>int <parameter>mode</parameter></paramdef>
</funcprototype>
</funcsynopsis>

</refsynopsisdiv>

<refsect1><title>Assembler Equivalent</title>
<para>
os9 I$OPEN
</para>
</refsect1>

<refsect1><title>Description</title>
<para>
This call opens an existing file for reading if "mode" is 1,
writing if "mode" is 2, or reading and writing if "mode" is 3.
NOTE that these values are OS-9 specific and not compatible
with other systems. "Fname" should point to a string
representing the pathname of the file.
</para>
<para>
Open returns an integer as "path number" which should be used
by i/o system calls referring to the file.
</para>
<para>
The position where reads or writes start is at the beginning of
the file.
</para>
</refsect1>

<refsect1><title>Diagnostics</title>
<para>
-1 is returned if the file does not exist, if the pathname
cannot be searched, if too many files are already open, or if
the file permissions deny the requested mode.
</para>
</refsect1>

<refsect1><title>See Also</title>
<para>
<link linkend="creat">creat()</link>,
<link linkend="read">read()</link>,
<link linkend="write">write()</link>,
<link linkend="dup">dup()</link>,
<link linkend="close">close()</link>
</para>
</refsect1>

</refentry>