summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWade A Smith <warm38@juno.com>1998-09-30 15:40:47 +0000
committerWade A Smith <warm38@juno.com>1998-09-30 15:40:47 +0000
commit9dd238772fa28013e6ea13b000d1c595e1f78ed1 (patch)
tree524ab571d7ff42b424acdb55aeb50bee80791bfc
parentPatch from Eric Norum <eric@skatter.USask.Ca>: (diff)
downloadrtems-9dd238772fa28013e6ea13b000d1c595e1f78ed1.tar.bz2
Updated the STATUS CODE section for the truncate routine.
-rw-r--r--doc/new_chapters/files.t28
1 files changed, 24 insertions, 4 deletions
diff --git a/doc/new_chapters/files.t b/doc/new_chapters/files.t
index f79c161350..40c31db4dc 100644
--- a/doc/new_chapters/files.t
+++ b/doc/new_chapters/files.t
@@ -41,10 +41,10 @@ The directives provided by the files and directories manager are:
@item @code{chown} - Changes the owner and/ or group of a file
@item @code{utime} - Change access and/or modification times of an inode
@item @code{ftruncate} - Truncate a file to a specified length
-@itme @code{truncate} - Truncate a file to a specified length
+@item @code{truncate} - Truncate a file to a specified length
@item @code{pathconf} - Gets configuration values for files
@item @code{fpathconf} - Get configuration values for files
-@itme @code{mknod} - Create a directory
+@item @code{mknod} - Create a directory
@end itemize
@section Background
@@ -1390,14 +1390,34 @@ long getdents(
@subheading STATUS CODES:
+on sucess, the number of bytes read is returned. On end of directory,
+0 is returned. On error, -1 is returned, and @code{errno} is set
+appropriately.
+
@table @b
-@item E
-The
+@item EBADF
+Invalid file descriptor @code{fd}.
+
+@item EFAULT
+Argument points outside the calling process's address space.
+
+@item EINVAL
+Result buffer is too small.
+
+@item ENOENT
+No such directory.
+
+@item ENOTDIR
+File descriptor does not refer to a directory.
@end table
@subheading DESCRIPTION:
+@code{getdents} reads several @code{dirent} structures from the directory
+pointed by @code{fd} into the memory area pointed to by @code{dirp}. The
+parameter @code{count} is the size of the memory area.
+
@subheading NOTES:
NONE