libexplain/buffer/errno/fclose.h File Reference

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

Go to the source code of this file.

Functions
void	explain_buffer_errno_fclose (explain_string_buffer_t *sb, int errnum, FILE *fp)
void	explain_buffer_errno_fclose_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, FILE *fp)

---

Function Documentation

void explain_buffer_errno_fclose	(	explain_string_buffer_t *	sb,
		int	errnum,
		FILE *	fp
	)

The explain_buffer_errno_fclose function is used to obtain an explanation of an error returned by the fclose(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 in which the message is being constructed. If a safe buffer is specified, this function is thread safe.
errnum	The error value to be decoded, usually obtain 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.
fp	The original fp, exactly has passed to the fclose(3) system call.

Definition at line 122 of file fclose.c.

void explain_buffer_errno_fclose_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		FILE *	fp
	)

The explain_buffer_errno_fclose_explanation function is used by the explain_buffer_errno_fclose function (and others) to print the extended "because..." part of the explanation.

Parameters:

sb	The string buffer in which the message is being constructed.
errnum	The error value to be decoded.
syscall_name	The name of the offending system call.
fp	The original fp, exactly has passed to the fclose(3) system call.

Definition at line 47 of file fclose.c.