libexplain/message/errno/mkostemp.c File Reference

#include <libexplain/buffer/errno/mkostemp.h>
#include <libexplain/mkostemp.h>

Go to the source code of this file.

Functions
void	explain_message_errno_mkostemp (char *message, int message_size, int errnum, const char *templat, int flags)

---

Function Documentation

void explain_message_errno_mkostemp	(	char *	message,
		int	message_size,
		int	errnum,
		const char *	pathname,
		int	flags
	)

The explain_message_errno_mkostemp function is used to obtain an explanation of an error returned by the mkostemp(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.
pathname	The original template, exactly as passed to the mkostemp(3) system call.
flags	The original flags, exactly as passed to the mkostemp(3) system call.

Example:

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

 int result = mkostemp(pathname, flags);
 if (result < 0)
 {
     int err = errno;
     char message[3000];
     explain_message_errno_mkostemp(message, sizeof(message), err, pathname,
         flags);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

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

Definition at line 24 of file mkostemp.c.