explain_fstatfs_or_die man page

explain_fstatfs_or_die — get file system statistics and report errors

Synopsis

#include <libexplain/fstatfs.h>

void explain_fstatfs_or_die(int fildes, struct statfs *data);
int explain_fstatfs_on_error(int fildes, struct statfs *data);

Description

The explain_fstatfs_or_die function is used to call the fstatfs(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_fstatfs(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

The explain_fstatfs_on_error function is used to call the fstatfs(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_fstatfs(3) function, but still returns to the caller.

fildes
The fildes, exactly as to be passed to the fstatfs(2) system call.
data
The data, exactly as to be passed to the fstatfs(2) system call.

Return Value

The explain_fstatfs_or_die function only returns on success, see fstatfs(2) for more information. On failure, prints an explanation and exits, it does not return.

The explain_fstatfs_on_error function always returns the value return by the wrapped fstatfs(2) system call.

Example

The explain_fstatfs_or_die function is intended to be used in a fashion similar to the following example:

explain_fstatfs_or_die(fildes, data);

See Also

fstatfs(2)
get file system statistics
explain_fstatfs(3)
explain fstatfs(2) errors
exit(2)
terminate the calling process

Referenced By

explain(3), explain_fstatfs(3).