libexplain/buffer/errno/flock.h File Reference

#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_flock (explain_string_buffer_t *sb, int errnum, int fildes, int command)
int	explain_flock_command_parse_or_die (const char *text, const char *caption)

---

Function Documentation

void explain_buffer_errno_flock	(	explain_string_buffer_t *	sb,
		int	errnum,
		int	fildes,
		int	command
	)

The explain_buffer_errno_flock function is used to obtain an explanation of an error returned by the flock(2) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:

sb	The string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
errnum	The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
fildes	The original fildes, exactly as passed to the flock(2) system call.
command	The original command, exactly as passed to the flock(2) system call.

Definition at line 125 of file flock.c.

int explain_flock_command_parse_or_die	(	const char *	text,
		const char *	caption
	)

The explain_flock_command_parse function may be used to parse a text representation of a flock command argument, and return a numeric value. Prints error message and exits if string cannot be parsed.

Parameters:

text	The text to be parsed.
caption	Additional caption to be added to error message, if needed.

Returns:

integer value of command

Definition at line 58 of file flock.c.