libexplain/mount_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/sys/mount.h>
#include <libexplain/mount.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
void	explain_mount_or_die (const char *source, const char *target, const char *file_systems_type, unsigned long flags, const void *data)
int	explain_mount_on_error (const char *source, const char *target, const char *file_systems_type, unsigned long flags, const void *data)

---

Function Documentation

int explain_mount_on_error	(	const char *	source,
		const char *	target,
		const char *	file_system_type,
		unsigned long	flags,
		const void *	data
	)

The explain_mount_on_error function is used to call the mount(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_mount(3) function.

Parameters:

source	The source, exactly as to be passed to the mount(2) system call.
target	The target, exactly as to be passed to the mount(2) system call.
file_system_type	The file_system_type, exactly as to be passed to the mount(2) system call.
flags	The flags, exactly as to be passed to the mount(2) system call.
data	The data, exactly as to be passed to the mount(2) system call.

Returns:

The value returned by the wrapped mount(2) system call.

Example:

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

 if (explain_mount_on_error(source, target, file_system_type, flags, data) <
     0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 39 of file mount_or_die.c.

void explain_mount_or_die	(	const char *	source,
		const char *	target,
		const char *	file_system_type,
		unsigned long	flags,
		const void *	data
	)

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

Parameters:

source	The source, exactly as to be passed to the mount(2) system call.
target	The target, exactly as to be passed to the mount(2) system call.
file_system_type	The file_system_type, exactly as to be passed to the mount(2) system call.
flags	The flags, exactly as to be passed to the mount(2) system call.
data	The data, exactly as to be passed to the mount(2) system call.

Returns:

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

Example:

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

 explain_mount_or_die(source, target, file_system_type, flags, data);

Definition at line 27 of file mount_or_die.c.