libexplain/message/setbuffer.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/stdio.h>
#include <libexplain/setbuffer.h>

Go to the source code of this file.

Functions
void	explain_message_setbuffer (char *message, int message_size, FILE *fp, char *data, size_t size)

---

Function Documentation

void explain_message_setbuffer	(	char *	message,
		int	message_size,
		FILE *	fp,
		char *	data,
		size_t	size
	)

The explain_message_setbuffer function is used to obtain an explanation of an error returned by the setbuffer(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.

The errno global variable will be used to obtain the error value to be decoded.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
fp	The original fp, exactly as passed to the setbuffer(3) system call.
data	The original data, exactly as passed to the setbuffer(3) system call.
size	The original size, exactly as passed to the setbuffer(3) system call.

Example:

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

 void result = setbuffer(fp, data, size);
 if (result < 0)
 {
     char message[3000];
     explain_message_setbuffer(message, sizeof(message), fp, data, size);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_setbuffer_or_die function.

Definition at line 26 of file setbuffer.c.