Changeset 9dd23877 in rtems for doc/new_chapters/files.t

Timestamp:

09/30/98 15:40:47 (24 years ago)

Author:

Wade A Smith <warm38@…>

Branches:

4.10, 4.11, 4.8, 4.9, 5, master

Children:

a65c28e

Parents:

17408b90

Message:

Updated the STATUS CODE section for the truncate routine.

File:

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

doc/new_chapters/files.t

@@ -42 +42 @@
 @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
 
@@ -1391 +1391 @@
 @subheading STATUS CODES:
 
-@table @b
-@item E
-The
-
-@end table
-
-@subheading DESCRIPTION:
+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 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: