annotate docs/ccguide/access.refentry @ 594:c0da1728ed5b

All refentries finished.
author roug
date Fri, 15 Nov 2002 21:49:51 +0000
parents fcb97f0ba24b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
1 <refentry id="access">
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
2 <refnamediv>
468
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
3 <refname>Access</refname>
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
4 <refpurpose>give file accessibility</refpurpose>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
5 </refnamediv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
6
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
7 <refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
8 <funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
9 <funcprototype>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
10 <funcdef><function>access</function></funcdef>
594
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
11 <paramdef>char *<parameter>fname</parameter></paramdef>
468
60b821f18853 A little here and there.
roug
parents: 466
diff changeset
12 <paramdef>int <parameter>perm</parameter></paramdef>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
13 </funcprototype>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
14 </funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
15
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
16 </refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
17
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
18 <refsect1><title>Description</title>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
19 <para>
594
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
20 Access returns 0 if the access modes specified in "perm" are
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
21 correct for the user to access "fname". -1 is returned if the
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
22 file cannot be accessed.
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
23 </para>
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
24 <para>
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
25 The value for "perm" may be any legal OS-9 mode as used for
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
26 "open()" or "creat()", it may be zero, which tests whether the
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
27 file exists, or the path to it may be searched.
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
28 </para>
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
29 </refsect1>
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
30 <refsect1><title>Caveats</title>
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
31 <para>
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
32 NOTE that the "perm" value is <emphasis>not</emphasis> compatible with other
c0da1728ed5b All refentries finished.
roug
parents: 552
diff changeset
33 systems.
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
34 </para>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
35 </refsect1>
552
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
36 <refsect1><title>Diagnostics</title>
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
37 <para>
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
38 The appropiate error indication, if a value of -1 is returned,
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
39 may be found in "errno".
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
40 </para>
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
41 </refsect1>
fcb97f0ba24b All diagnostics added.
roug
parents: 468
diff changeset
42
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
43 </refentry>