Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

getfh(2) [netbsd man page]

GETFH(2)						      BSD System Calls Manual							  GETFH(2)

NAME
getfh -- get file handle LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <sys/types.h> #include <sys/mount.h> int getfh(const char *path, void *fhp, size_t *fh_size); DESCRIPTION
getfh() returns a file handle for the specified file or directory in the file handle pointed to by fhp. The variable pointed to by fh_size has to be initialized to the memory allocated for the variable sized file handle. On return the value will be replaced by the actual size needed (which will vary depending on the file system the path is on). This system call is restricted to the superuser. To query the neces- sary size for the filehandle, a NULL pointer may be passed as fhp, and the value pointed to by fh_size should be initialized to zero. 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
getfh() fails 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] fhp points to an invalid address. [EIO] An I/O error occurred while reading from or writing to the file system. [E2BIG] The memory allocated for the file handle is too small. The size needed has been written to the variable pointed to by fh_size. [ENOMEM] The kernel failed to allocate temporary memory to create a filehandle of the requested size. SEE ALSO
fhstat(2), fhstatvfs(2), fhstatvfs1(2) HISTORY
The getfh() function first appeared in 4.4BSD. BSD
October 30, 2006 BSD

Check Out this Related 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
Man Page