libexplain/buffer/errno/strcoll.h File Reference

#include <libexplain/ac/string.h>
#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_strcoll (explain_string_buffer_t *sb, int errnum, const char *s1, const char *s2)
void	explain_buffer_errno_strcoll_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, const char *s1, const char *s2)

---

Function Documentation

void explain_buffer_errno_strcoll	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	s1,
		const char *	s2
	)

The explain_buffer_errno_strcoll function is used to obtain an explanation of an error returned by the strcoll(3) 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.
s1	The original s1, exactly as passed to the strcoll(3) system call.
s2	The original s2, exactly as passed to the strcoll(3) system call.

Definition at line 57 of file strcoll.c.

void explain_buffer_errno_strcoll_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		const char *	s1,
		const char *	s2
	)

The explain_buffer_errno_strcoll_explanation function is used to obtain the explanation (the part after "because") of an error returned by the strcoll(3) system call (and similar).

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.
syscall_name	The name of the offending system call.
s1	The original s1, exactly as passed to the strcoll(3) system call.
s2	The original s2, exactly as passed to the strcoll(3) system call.

Definition at line 41 of file strcoll.c.