libexplain/strcoll_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/string.h>
#include <libexplain/output.h>
#include <libexplain/strcoll.h>

Go to the source code of this file.

Functions
int	explain_strcoll_or_die (const char *s1, const char *s2)
int	explain_strcoll_on_error (const char *s1, const char *s2)

---

Function Documentation

int explain_strcoll_on_error	(	const char *	s1,
		const char *	s2
	)

The explain_strcoll_on_error function is used to call the strcoll(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_strcoll(3) function.

Parameters:

s1	The s1, exactly as to be passed to the strcoll(3) system call.
s2	The s2, exactly as to be passed to the strcoll(3) system call.

Returns:

The value returned by the wrapped strcoll(3) system call.

Example:

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

 errno = 0;
 int result = explain_strcoll_on_error(s1, s2);
 if (result < 0 && errno != 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 42 of file strcoll_or_die.c.

int explain_strcoll_or_die	(	const char *	s1,
		const char *	s2
	)

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

Parameters:

s1	The s1, exactly as to be passed to the strcoll(3) system call.
s2	The s2, exactly as to be passed to the strcoll(3) system call.

Returns:

This function only returns on success, see strcoll(3) 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:

 int result = explain_strcoll_or_die(s1, s2);

Definition at line 27 of file strcoll_or_die.c.