libexplain/buffer/utimensat_flags.h File Reference

#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_utimensat_flags (explain_string_buffer_t *sb, int value)
int	explain_allbits_utimensat_flags (void)
int	explain_parse_utimensat_flags (const char *text, int *result)
int	explain_parse_utimensat_flags_or_die (const char *text, const char *caption)

---

Function Documentation

int explain_allbits_utimensat_flags

(

void

)

The explain_allbits_utimensat_flags function is used to get a bit mask of the valid options. This helps in an EINVAL explanation.

Definition at line 68 of file utimensat_flags.c.

void explain_buffer_utimensat_flags	(	explain_string_buffer_t *	sb,
		int	value
	)

The explain_buffer_utimensat_flags function may be used to print a representation of a utimensat flags value.

Parameters:

sb	The string buffer to print into.
value	The utimensat flags value to be printed.

Definition at line 47 of file utimensat_flags.c.

int explain_parse_utimensat_flags	(	const char *	text,
		int *	result
	)

The explain_parse_utimensat_flags function is used to parse a text string to extract a suitable 'flags' argument for the utimensat function.

Parameters:

text	The text string to be parsed.
result	where to put the result

Returns:

0 on success, < 0 on failure

Definition at line 61 of file utimensat_flags.c.

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

The explain_parse_utimensat_flags function is used to

Parameters:

text	The text string to be parsed for a flags value.
caption	Caption to add to start of error message, or NULL for none

Returns:

The value of the expression. Does not return on error, but prints diagnostic and exits EXIT_FAILURE.

Note:

this function is not thread safe

Definition at line 54 of file utimensat_flags.c.