libexplain/vsprintf.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/stdarg.h>
#include <libexplain/ac/stdio.h>
#include <libexplain/buffer/errno/vsprintf.h>
#include <libexplain/common_message_buffer.h>
#include <libexplain/vsprintf.h>

Go to the source code of this file.

Functions
const char *	explain_vsprintf (char *data, const char *format, va_list ap)
const char *	explain_errno_vsprintf (int errnum, char *data, const char *format, va_list ap)
void	explain_message_vsprintf (char *message, int message_size, char *data, const char *format, va_list ap)
void	explain_message_errno_vsprintf (char *message, int message_size, int errnum, char *data, const char *format, va_list ap)

---

Function Documentation

const char* explain_errno_vsprintf	(	int	errnum,
		char *	data,
		const char *	format,
		va_list	ap
	)

The explain_errno_vsprintf function is used to obtain an explanation of an error returned by the vsprintf(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:

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.
data	The original data, exactly as passed to the vsprintf(3) system call.
format	The original format, exactly as passed to the vsprintf(3) system call.
ap	The original ap, exactly as passed to the vsprintf(3) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example:

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

 errno = 0;
 int result = vsprintf(data, format, ap);
 if (result < 0 && errno != 0)
 {
     int err = errno;
     fprintf(stderr, "%s\n", explain_errno_vsprintf(err, data, format, ap));
     exit(EXIT_FAILURE);
 }

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

Definition at line 36 of file vsprintf.c.

void explain_message_errno_vsprintf	(	char *	message,
		int	message_size,
		int	errnum,
		char *	data,
		const char *	format,
		va_list	ap
	)

The explain_message_errno_vsprintf function is used to obtain an explanation of an error returned by the vsprintf(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:

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.
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.
data	The original data, exactly as passed to the vsprintf(3) system call.
format	The original format, exactly as passed to the vsprintf(3) system call.
ap	The original ap, exactly as passed to the vsprintf(3) system call.

Example:

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

 errno = 0;
 int result = vsprintf(data, format, ap);
 if (result < 0 && errno != 0)
 {
     int err = errno;
     char message[3000];
     explain_message_errno_vsprintf(message, sizeof(message), err, data,
         format, ap);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

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

Definition at line 54 of file vsprintf.c.

void explain_message_vsprintf	(	char *	message,
		int	message_size,
		char *	data,
		const char *	format,
		va_list	ap
	)

The explain_message_vsprintf function is used to obtain an explanation of an error returned by the vsprintf(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.
data	The original data, exactly as passed to the vsprintf(3) system call.
format	The original format, exactly as passed to the vsprintf(3) system call.
ap	The original ap, exactly as passed to the vsprintf(3) system call.

Example:

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

 errno = 0;
 int result = vsprintf(data, format, ap);
 if (result < 0 && errno != 0)
 {
     char message[3000];
     explain_message_vsprintf(message, sizeof(message), data, format, ap);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

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

Definition at line 45 of file vsprintf.c.

const char* explain_vsprintf	(	char *	data,
		const char *	format,
		va_list	ap
	)

The explain_vsprintf function is used to obtain an explanation of an error returned by the vsprintf(3) system call. The least the message will contain is the value of strerror(errno), 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:

data	The original data, exactly as passed to the vsprintf(3) system call.
format	The original format, exactly as passed to the vsprintf(3) system call.
ap	The original ap, exactly as passed to the vsprintf(3) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example:

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

 errno = 0;
 int result = vsprintf(data, format, ap);
 if (result < 0 && errno != 0)
 {
     fprintf(stderr, "%s\n", explain_vsprintf(data, format, ap));
     exit(EXIT_FAILURE);
 }

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

Definition at line 29 of file vsprintf.c.