libexplain/utimens.h File Reference

explain utimens(2) errors More...

#include <libexplain/gcc_attributes.h>
#include <libexplain/large_file_support.h>

Go to the source code of this file.

Functions
void	explain_utimens_or_die (const char *pathname, const struct timespec *data)
int	explain_utimens_on_error (const char *pathname, const struct timespec *data)
const char *	explain_utimens (const char *pathname, const struct timespec *data) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_errno_utimens (int errnum, const char *pathname, const struct timespec *data) LIBEXPLAIN_WARN_UNUSED_RESULT
void	explain_message_utimens (char *message, int message_size, const char *pathname, const struct timespec *data)
void	explain_message_errno_utimens (char *message, int message_size, int errnum, const char *pathname, const struct timespec *data)

---

Detailed Description

explain utimens(2) errors

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

Definition in file utimens.h.

---

Function Documentation

const char* explain_errno_utimens	(	int	errnum,
		const char *	pathname,
		const struct timespec *	data
	)

The explain_errno_utimens function is used to obtain an explanation of an error returned by the utimens(2) 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 pathname, exactly as passed to the utimens(2) system call.
data	The original data, exactly as passed to the utimens(2) 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:

 if (utimens(pathname, data) < 0)
 {
     int err = errno;
     fprintf(stderr, "%s\n", explain_errno_utimens(err, pathname, data));
     exit(EXIT_FAILURE);
 }

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

Definition at line 35 of file utimens.c.

void explain_message_errno_utimens	(	char *	message,
		int	message_size,
		int	errnum,
		const char *	pathname,
		const struct timespec *	data
	)

The explain_message_errno_utimens function is used to obtain an explanation of an error returned by the utimens(2) 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 pathname, exactly as passed to the utimens(2) system call.
data	The original data, exactly as passed to the utimens(2) system call.

Example:

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

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

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

Definition at line 53 of file utimens.c.

void explain_message_utimens	(	char *	message,
		int	message_size,
		const char *	pathname,
		const struct timespec *	data
	)

The explain_message_utimens function is used to obtain an explanation of an error returned by the utimens(2) 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 pathname, exactly as passed to the utimens(2) system call.
data	The original data, exactly as passed to the utimens(2) system call.

Example:

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

 if (utimens(pathname, data) < 0)
 {
     char message[3000];
     explain_message_utimens(message, sizeof(message), pathname, data);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

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

Definition at line 45 of file utimens.c.

const char* explain_utimens	(	const char *	pathname,
		const struct timespec *	data
	)

The explain_utimens function is used to obtain an explanation of an error returned by the utimens(2) 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 pathname, exactly as passed to the utimens(2) system call.
data	The original data, exactly as passed to the utimens(2) 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:

 if (utimens(pathname, data) < 0)
 {
     fprintf(stderr, "%s\n", explain_utimens(pathname, data));
     exit(EXIT_FAILURE);
 }

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

Definition at line 28 of file utimens.c.

int explain_utimens_on_error	(	const char *	pathname,
		const struct timespec *	data
	)

The explain_utimens_on_error function is used to call the utimens(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_utimens(3) function.

Parameters:

pathname	The pathname, exactly as to be passed to the utimens(2) system call.
data	The data, exactly as to be passed to the utimens(2) system call.

Returns:

The value returned by the wrapped utimens(2) system call.

Example:

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

 if (explain_utimens_on_error(pathname, data) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 57 of file utimens_or_die.c.

void explain_utimens_or_die	(	const char *	pathname,
		const struct timespec *	data
	)

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

Parameters:

pathname	The pathname, exactly as to be passed to the utimens(2) system call.
data	The data, exactly as to be passed to the utimens(2) system call.

Returns:

This function only returns on success, see utimens(2) 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:

 explain_utimens_or_die(pathname, data);

Definition at line 29 of file utimens_or_die.c.