STAT(2-SVR3)        RISC/os Reference Manual         STAT(2-SVR3)



NAME
     stat, lstat, fstat - get file status

SYNOPSIS
     #include <sys/types.h>
     #include <sys/stat.h>

     int stat (path, buf)
     char *path;
     struct stat *buf;

     int lstat (path, buf)
     char *path;
     struct stat *buf;

     int fstat (fildes, buf)
     int fildes;
     struct stat *buf;

DESCRIPTION
     path points to a path name naming a file.  Read, write, or
     execute permission of the named file is not required, but
     all directories listed in the path name leading to the file
     must be searchable.  stat obtains information about the
     named file.  lstat is the same as stat except that when path
     names a symbolic link, the information retrieved is for the
     symbolic link instead of the file it points to.

     fstat obtains information about an open file known by the
     file descriptor fildes, obtained from a successful open,
     creat, dup, fcntl, or pipe system call.

     buf is a pointer to a stat structure into which information
     is placed concerning the file.

     The contents of the structure pointed to by buf include the
     following members:

     ushort  st_mode;    /* File mode [see mknod(2)] */
     ino_t   st_ino;     /* Inode number */
     dev_t   st_dev;     /* ID of device containing */
                         /* a directory entry for this file */
     dev_t   st_rdev;    /* ID of device */
                         /* This entry is defined only for */
                         /* character special or block special */
                         /* files */
     short   st_nlink;   /* Number of links */
     ushort  st_uid;     /* User ID of the file's owner */
     ushort  st_gid;     /* Group ID of the file's group */
     off_t   st_size;    /* File size in bytes */
     time_t  st_atime;   /* Time of last access */
     time_t  st_mtime;   /* Time of last data modification */



                        Printed 11/19/92                   Page 1

STAT(2-SVR3)        RISC/os Reference Manual         STAT(2-SVR3)



     time_t  st_ctime;   /* Time of last file status change */
                         /* Times measured in seconds since */
                         /* 00:00:00 GMT, Jan. 1, 1970 */

     stmode   The mode of the file as described in the mknod(2)
               system call.

     stino    This field uniquely identifies the file in a given
               file system.  The pair st_ino and st_dev uniquely
               identifies regular files.

     stdev    This field uniquely identifies the file system
               that contains the file.  Its value may be used as
               input to the ustat(2) system call to determine
               more information about this file system.  No other
               meaning is associated with this value.

     strdev   This field should be used only by administrative
               commands.  It is valid only for block special or
               character special files and only has meaning on
               the system where the file was configured.

     stnlink  This field should be used only by administrative
               commands.

     stuid    The user ID of the file's owner.

     stgid    The group ID of the file's group.

     stsize   For regular files, this is the address of the end
               of the file.  For pipes or fifos, this is the
               count of the data currently in the file.  For
               block special or character special, this is not
               defined.

     statime  Time when file data was last accessed.  Changed by
               the following system calls:  creat(2), mknod(2),
               pipe(2), utime(2), and read(2).

     stmtime  Time when data was last modified.  Changed by the
               following system calls:  creat(2), mknod(2),
               pipe(2), utime(2), and write(2).

     stctime  Time when file status was last changed.  Changed
               by the following system calls:  chmod(2),
               chown(2), creat(2), link(2), mknod(2), pipe(2),
               unlink(2), utime(2), and write(2).

ERRORS
     stat and lstat will fail if one or more of the following are
     true:




 Page 2                 Printed 11/19/92

STAT(2-SVR3)        RISC/os Reference Manual         STAT(2-SVR3)



     [ENOTDIR]      A component of the path prefix is not a
                    directory.

     [ENOENT]       The named file does not exist.

     [EACCES]       Search permission is denied for a component
                    of the path prefix.

     [EFAULT]       buf or path points to an invalid address.

     [EINTR]        A signal was caught during the stat system
                    call.

     [ENOLINK]      path points to a remote machine and the link
                    to that machine is no longer active.

     [EMULTIHOP]    Components of path require hopping to multi-
                    ple remote machines.

     fstat will fail if one or more of the following are true:

     [EBADF]        fildes is not a valid open file descriptor.

     [EFAULT]       buf points to an invalid address.

     [ENOLINK]      fildes points to a remote machine and the
                    link to that machine is no longer active.

SEE ALSO
     chmod(2), chown(2), creat(2), link(2), mknod(2), pipe(2),
     read(2), time(2), unlink(2), utime(2), write(2).

DIAGNOSTICS
     Upon successful completion a value of 0 is returned.  Other-
     wise, a value of -1 is returned and errno is set to indicate
     the error.



















                        Printed 11/19/92                   Page 3