|HP-UX Reference > S
HP-UX 11i Version 3: February 2007
stat — get file status
The stat() function obtains information about the named file and writes it to the area pointed to by the buf argument. The path argument is a pointer to a path name of any file within the mounted file system. (All directories listed in the path name must be searchable). Read, write or execute permission of the named file is not required, but all directories listed in the pathname leading to all directories listed in the pathname leading to the file must be searchable. An implementation that provides additional or alternate file access control mechanisms may, under implementation-dependent conditions, cause stat() to fail. In particular, the system may deny the existence of the file specified by path.
The buf argument is a pointer to a stat structure, as defined in the header <sys/stat.h>, into which information is placed concerning the file. The stat structure contains the following members:
dev_t st_dev; /* ID of device containing a */ /* directory entry for this file */ ino_t st_ino; /* Inode number */ short st_fstype; /* Type of filesystem this file */ /* is in; see sysfs(2) */ ushort st_mode; /* File type, attributes, and */ /* access control summary */ ushort st_basemode /* Permission bits (see chmod(1)) */ ushort st_nlink; /* Number of links */ uid_t st_uid; /* User ID of file owner */ gid_t st_gid; /* Group ID of file group */ dev_t st_rdev; /* Device ID; this entry defined */ /* only for char or blk spec files */ off_t st_size; /* File size (bytes) */ time_t st_atime; /* Time of last access */ time_t st_mtime; /* Last modification time */ time_t st_ctime; /* Last file status change time */ /* Measured in secs since */ /* 00:00:00 GMT, Jan 1, 1970 */ long st_blksize; /* File system block size */ blkcnt_t st_blocks; /* Number of blocks of a */ /* file-system-specific size */ /* allocated for this object */ uint st_acl:1; /* Set if the file has optional */ /* access control list entries */ /* HFS File Systems only */ uint st_aclv:1; /* Set if the file has optional */ /* access control list entries */ /* JFS File Systems only */
(Note that the position of items in this list does not necessarily reflect the order of the members in the structure.)
If the chosen path name or file descriptor refers to a Multi-Level Directory (MLD), and the process does not have the multilevel effective privilege, the i-node number returned in st_ino is the i-node of the MLD itself.
The stat() function updates any time-related fields (as described in the definition of File Times Update in the XBD specification), before writing into the stat structure.
The structure members st_mode, st_ino, st_dev, st_uid, st_gid, st_atime, st_ctime, and st_mtime will have meaningful values for all file types defined in this document. The value of the member st_nlink will be set to the number of links to the file.
Upon successful completion, 0 is returned. Otherwise, -1 is returned and errno is set to indicate the error.
The stat() function will fail if:
The stat() function may fail if:
stat() and fstat() were developed by AT&T. lstat() was developed by the University of California, Berkeley.
touch(1), acl(2), chmod(2), chown(2), creat(2), fstat(2), link(2), lstat(2), mknod(2), pipe(2), read(2), rename(2), setacl(2), stat64(2), sysfs(2), time(2), truncate(2), unlink(2), utime(2), write(2), acl(5), aclv(5), privileges(5), stat(5), <sys/stat.h>, <sys/types.h>.