libexplain/mkostemp.h File Reference

explain mkostemp(3) errors More...

#include <libexplain/gcc_attributes.h>

Go to the source code of this file.

Functions
int	explain_mkostemp_or_die (char *pathname, int flags)
int	explain_mkostemp_on_error (char *pathname, int flags)
const char *	explain_mkostemp (const char *pathname, int flags) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_errno_mkostemp (int errnum, const char *pathname, int flags) LIBEXPLAIN_WARN_UNUSED_RESULT
void	explain_message_mkostemp (char *message, int message_size, const char *pathname, int flags)
void	explain_message_errno_mkostemp (char *message, int message_size, int errnum, const char *pathname, int flags)

---

Detailed Description

explain mkostemp(3) errors

These functions may be used to obtain explanations for errors returned by the mkostemp(3) system call.

Definition in file mkostemp.h.

---

Function Documentation

const char* explain_errno_mkostemp	(	int	errnum,
		const char *	pathname,
		int	flags
	)

The explain_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:

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.

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:

 int result = mkostemp(pathname, flags);
 if (result < 0)
 {
     int err = errno;
     fprintf(stderr, "%s\n", explain_errno_mkostemp(err, pathname, flags));
     exit(EXIT_FAILURE);
 }

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

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.

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

The explain_message_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.

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.
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)
 {
     char message[3000];
     explain_message_mkostemp(message, sizeof(message), 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.

const char* explain_mkostemp	(	const char *	pathname,
		int	flags
	)

The explain_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(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:

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.

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:

 int result = mkostemp(pathname, flags);
 if (result < 0)
 {
     fprintf(stderr, "%s\n", explain_mkostemp(pathname, flags));
     exit(EXIT_FAILURE);
 }

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

int explain_mkostemp_on_error	(	char *	pathname,
		int	flags
	)

The explain_mkostemp_on_error function is used to call the mkostemp(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_mkostemp(3) function.

Parameters:

pathname	The template, exactly as to be passed to the mkostemp(3) system call. The last six characters of template must be "XXXXXX" and these are replaced with a string that makes the filename unique. Since it will be modified, template must not be a string constant, but should be declared as a character array.
flags	The flags, exactly as to be passed to the mkostemp(3) system call.

Returns:

The value returned by the wrapped mkostemp(3) system call.

Example:

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

 int result = explain_mkostemp_on_error(pathname, flags);
 if (result < 0)
 {
     ...cope with error
     ...no need to print error message
 }

int explain_mkostemp_or_die	(	char *	pathname,
		int	flags
	)

The explain_mkostemp_or_die function is used to call the mkostemp(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_mkostemp(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

Parameters:

pathname	The template, exactly as to be passed to the mkostemp(3) system call. The last six characters of template must be "XXXXXX" and these are replaced with a string that makes the filename unique. Since it will be modified, template must not be a string constant, but should be declared as a character array.
flags	The flags, exactly as to be passed to the mkostemp(3) system call.

Returns:

This function only returns on success, see mkostemp(3) for more information. On failure, prints an explanation and exits, it does not return.

Example:

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

 int result = explain_mkostemp_or_die(pathname, flags);