Changeset 9a0b008 in rtems

Timestamp:

09/25/98 16:20:52 (24 years ago)

Author:

Wade A Smith <warm38@…>

Branches:

4.10, 4.11, 4.8, 4.9, 5, master

Children:

64183e20

Parents:

165988d

Message:

Docmumented the access routine in for this file.

File:

• doc/new_chapters/files.t (modified) (2 diffs)

doc/new_chapters/files.t

@@ -36 +36 @@
 @item @code{stat} - Gets information about a file.
 @item @code{fstat} - 
-@item @code{access} - 
+@item @code{access} - Check user's permissions for a file.
 @item @code{chmod} - Changes file mode
 @item @code{fchmod} - 
@@ -942 +942 @@
 
 @page
-@subsection access - 
-
-@subheading CALLING SEQUENCE:
-
-@ifset is-C
-@example
-int access(
-);
-@end example
-@end ifset
-
-@ifset is-Ada
-@end ifset
-
-@subheading STATUS CODES:
-
-@table @b
-@item E
-The
-
-@end table
-
-@subheading DESCRIPTION:
-
-@subheading NOTES:
+@subsection access - Check user's permissions for a file
+
+@subheading CALLING SEQUENCE:
+
+@ifset is-C
+@example
+#include <unistd.h>
+
+int access(const char *pathname,
+           int         mode
+);
+@end example
+@end ifset
+
+@ifset is-Ada
+@end ifset
+
+@subheading STATUS CODES:
+
+@table @b
+@item EACCES
+The requested access would be denied, either to the file itself or
+one of the directories in @code{pathname}.
+@item EFAULT
+@code{Pathname} points outside your accessible address space.
+@item EINVAL
+@code{Mode} was incorrectly specified.
+@item ENAMETOOLONG
+@code{Pathname} is too long.
+@item ENOENT
+A directory component in @code{pathname} would have been accessible but
+does not exist or was a dangling symbolic link.
+@item ENOTDIR
+A component used as a directory in @code{pathname} is not, in fact, 
+a directory.
+@item ENOMEM
+Insufficient kernel memory was available.
+
+@end table
+
+@subheading DESCRIPTION:
+
+@code{Access} checks whether the process would be allowed to read, write or 
+test for existence of the file (or other file system object) whose name is 
+@code{pathname}.  If @code{pathname} is a symbolic link permissions of the 
+file referred by this symbolic link are tested.
+
+@code{Mode} is a mask consisting of one or more of R_OK, W_OK, X_OK and F_OK.
+
+@subheading NOTES: None
 
 @page