Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

statvfs(2) [netbsd man page]

STATVFS(2)						      BSD System Calls Manual							STATVFS(2)

NAME
statvfs, statvfs1, fstatvfs, fstatvfs1 -- get file system statistics LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <sys/statvfs.h> int statvfs(const char *path, struct statvfs *buf); int statvfs1(const char *path, struct statvfs *buf, int flags); int fstatvfs(int fd, struct statvfs *buf); int fstatvfs1(int fd, struct statvfs *buf, int flags); DESCRIPTION
statvfs() and statvfs1() return information about a mounted file system. path is the path name of any file within the mounted file system. buf is a pointer to a statvfs structure defined in statvfs(5). fstatvfs() and fstatvfs1() return the same information about an open file referenced by descriptor fd. The statvfs1() and fstatvfs1() functions allow an extra flags argument which can be ST_WAIT and ST_NOWAIT. When ST_NOWAIT is specified, then only cached statistics are returned. This can result in significant savings on non-local filesystems, where gathering statistics involves a network communication. The statvfs() and fstatvfs() calls are equivalent to the respective statvfs1() and fstatvfs1() calls with ST_WAIT specified as the flags argument. RETURN VALUES
Upon successful completion, a value of 0 is returned. Otherwise, -1 is returned and the global variable errno is set to indicate the error. ERRORS
statvfs() and statvfs1() fail if one or more of the following are true: [ENOTDIR] A component of the path prefix of path is not a directory. [ENAMETOOLONG] The length of a component of path exceeds {NAME_MAX} characters, or the length of path exceeds {PATH_MAX} characters. [ENOENT] The file referred to by path does not exist. [EACCES] Search permission is denied for a component of the path prefix of path. [ELOOP] Too many symbolic links were encountered in translating path. [EFAULT] buf or path points to an invalid address. [EIO] An I/O error occurred while reading from or writing to the file system. fstatvfs() and fstatvfs1() fail if one or more of the following are true: [EBADF] fd is not a valid open file descriptor. [EFAULT] buf points to an invalid address. [EIO] An I/O error occurred while reading from or writing to the file system. SEE ALSO
statvfs(5) HISTORY
The statvfs(), statvfs1(), fstatvfs(), and fstatvfs1() functions first appeared in NetBSD 3.0 to replace the statfs() family of functions which first appeared in 4.4BSD. BSD
April 14, 2004 BSD

Check Out this Related Man Page

statvfs(2)							System Calls Manual							statvfs(2)

NAME
statvfs, fstatvfs - Gets file system information SYNOPSIS
#include <sys/statvfs.h> int statvfs ( const char *path, struct statvfs *buffer ); int fstatvfs ( int file_descriptor, struct statvfs *buffer ); STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: fstatvfs(): POSIX.1, XSH5.0 statvfs(): POSIX.1, XSH5.0 Refer to the standards(5) reference page for more information about industry standards and associated tags. PARAMETERS
Specifies any file within the mounted file system. Specifies a file descriptor obtained by a successful open() or fcntl() function. Points to a statvfs buffer to hold the returned information for the statvfs() or fstatvfs() function. DESCRIPTION
The statvfs() and fstatvfs() functions return descriptive information about a mounted file system. The returned information is in the for- mat of a statvfs structure, which is defined in the sys/statvfs.h header file. RETURN VALUES
Upon successful completion, either function returns 0 (zero). Otherwise, it returns -1, sets errno to indicate the error. If the statvfs() function fails, errno may be set to one of the following values: Search permission is denied for a component of the path prefix [Tru64 UNIX] The requested address is invalid. An I/O error occurred while reading the file system. A signal was caught during execution of the function. [Tru64 UNIX] The value returned by statvfs is invalid. Too many symbolic links were encountered in translat- ing the path parameter detected. The length of a component of the path parameter exceeds NAME_MAX characters, or the length of the path parameter exceeds PATH_MAX characters. The file referred to by the path parameter does not exist. A component of the path prefix of the path parameter is not a directory. If the fstatvfs() function fails, errno may be set to the following values: The file descriptor parameter is not a valid file descriptor. [Tru64 UNIX] The requested address is invalid. [Tru64 UNIX] The value returned by fstatvfs is invalid. RELATED INFORMATION
Functions: stat(2) Standards: standards(5) delim off statvfs(2)
Man Page